Loyalty Management Developer Guide
jBenefitAction
Supported SOAP API Calls
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
Supported REST API Methods
DELETE, GET, HEAD, PATCH, POST, Query
Special Access Rules
To use this object, the Loyalty Management license is required.
Fields
Description
Type: textarea
Properties: Filter, Group, Nillable, Sort
Description: The description of the benefit action.
DeveloperName
Type: string
Properties: Filter, Group, Sort
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. This field is automatically generated, but you can supply your own value if you create the record using the API.When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.
FlowDefinition
Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: The ID of the flow associated with the benefit action. The possible values depend on the flows defined in the org.
FlowInstance
Type: string
Properties: Filter, Group, Nillable, Sort
Description: The flow associated with the benefit action.
FullName
Type: string
Properties: Create, Group, Nillable
Description: The full name of the associated in Metadata API.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
IsActive
Type: boolean
Properties: Defaulted on create, Filter, Group, Sort
Description: Indicates whether the benefit action is active.
The default value is false.
IsBenefitExpirationAllowed
Type: boolean
Properties: Defaulted on create, Filter, Group, Sort
Description: Indicates whether the benefit action is allowed to expire the benefit.
The default value is false.
IsBenefitUpdateAllowed
Type: boolean
Properties: Defaulted on create, Filter, Group, Sort
Description: Indicates whether the benefit action is allowed to update the benefit.
The default value is false.
Language
Type: picklist
Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description: The language of the benefit action.
ManageableState
Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: Indicates the manageable state of the specified component that is contained in a package.
Possible values are:
- beta—Managed-Beta
- deleted—Managed-Proposed-Deleted
- deprecated—Managed-Proposed-Deprecated
- deprecatedEditable—SecondGen-Installed-Deprecated
- installed—Managed-Installed
- installedEditable—SecondGen-Installed-Editable
- released—Managed-Released
- unmanaged—Unmanaged
MasterLabel
Type: string
Properties: Filter, Group, Sort
Description: The UI label of the benefit action.
MemberBenefitVariableName
Type: string
Properties: Filter, Group, Nillable, Sort
Description: The name of the input variable that stores the member benefit ID in the flow specified for the benefit action. The field is available in API version 52.0 and later.
Metadata
Type: BenefitAction
Properties: Create, Nillable, Update
Description: Provides access to the associated metadata type and related fields in Tooling API.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
NamespacePrefix
Type: string
Properties: Filter, Group, Nillable, Sort
Description: The namespace prefix that is associated with this object. Each Developer Edition org 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.
ProcessType
Type: picklist
Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
Description: The process type of the benefit action.
Possible value is:
- Loyalty
The default value is Loyalty.
Type
Type: picklist
Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
Description: The type of the benefit action.
Possible value is:
- Flow
The default value is Flow.