LoyaltyProgram

Represents the loyalty program within an organization. All the information related to members, tiers, tier groups, program currencies, vouchers, benefits, partners, promotions, transactions are associated with the program. This object is available in API version 51.0 and later.

Supported Calls

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

Fields

Description

Type: string

Properties: Create, Filter, Nillable, Sort, Update

Description: Description of the loyalty program.

EscrowPeriod

Type: int

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The number of days after which the escrow points are credited to the existing points balance. This field is available in API version 53.0 and later.

IsPrimary

Type: boolean

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: Indicates whether a loyalty program is the primary program.

The default value is ‘false’. This field is available in API version 52.0 and later.

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: Create, Filter, Group, idLookup, Sort, Update

Description: Required. The name of the loyalty program. The name must contain at least one alphanumeric character and can’t contain special characters such as % and +.

OwnerId

Type: reference

Properties: Create, Defaulted on create, Filter, Group, Sort, Update

Description: ID of the owner of this record.

This is a polymorphic relationship field.

Relationship Name: Owner

Relationship Type: Lookup

Refers To: Group, User

Status

Type: picklist

Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update

Description: Required. The status of the loyalty program.

Possible values are:

Active
Inactive

Type

Type: picklist

Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update

Description: Specifies the type of loyalty program.

Possible values are:

LOYALTY_PROGRAM
REFERRAL_PROGRAM

The default value is LOYALTY_PROGRAM.

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.

LoyaltyProgramChangeEvent (API Version 62.0): Change events are available for the object.

LoyaltyProgramFeed: Feed tracking is available for the object.

LoyaltyProgramHistory: History is available for tracked fields of the object.

LoyaltyProgramOwnerSharingRule: Sharing rules are available for the object.

LoyaltyProgramShare: Sharing is available for the object.