BenefitAction

Represents details of an action that can be triggered for a benefit. This object is available in API version 51.0 and later.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Note

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Fields

Field	Details
Description	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The description of the benefit action.
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization.
FlowDefinition	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The ID of the flow associated with the benefit action. This field is available in API version 52.0 and later. Possible values are: `benefits__BenefitsFlow1` `industries_loyalty_promo__PromoFulfill` `runtime_appointmentbooking__Flow` `runtime_appointmentbooking__Guest_Flow` `runtime_appointmentbooking__In_Cancel` `runtime_appointmentbooking__In_Modify` `runtime_appointmentbooking__In_New` `runtime_appointmentbooking__Out_Modify` `runtime_sales_see__SEE` `setup_service_experience__Create_Case` `setup_service_experience__Reset_Pwd` `setup_service_experience__Verify_Cust`
FlowInstance	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The flow associated with the benefit action.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Required. Indicates whether the benefit action is active.
IsBenefitExpirationAllowed	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the benefit action is allowed to expire the benefit.
IsBenefitUpdateAllowed	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the benefit action is allowed to update a benefit.
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the benefit action. Possible values are: `da`—Danish `de`—German `en_US`—English `es`—Spanish `es_MX`—Spanish (Mexico) `fi`—Finnish `fr`—French `it`—Italian `ja`—Japanese `ko`—Korean `nl_NL`—Dutch `no`—Norwegian `pt_BR`—Portuguese (Brazil) `ru`—Russian `sv`—Swedish `th`—Thai `zh_CN`—Chinese (Simplified) `zh_TW`—Chinese (Traditional)
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description The label of the benefit action.
MemberBenefitVariableName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the input variable that stores the member benefit ID in the flow specified for the benefit action. This field is available in API version 52.0 and later.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation. The namespace prefix can have one of the following values: In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There’s an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer. In organizations that aren’t Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There’s no namespace prefix for all other objects.
ProcessType	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Required. The process type of the benefit action. Possible value is: `Loyalty`
Type	Type picklist Properties Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update Description Required. The type of benefit action. Possible value is: `Flow`

Loyalty Management Developer Guide

BenefitAction

Supported Calls

Fields