Loyalty Management Developer Guide

Loyalty Management Standard Objects
Apex Reference
Loyalty Management Business APIs
Loyalty Management Standard Invocable Actions
Loyalty Management Custom Invocable Actions
Run Program Process
Loyalty Management Metadata API Types
Loyalty Management Tooling API Objects
Data Processing Engine, Batch Management, and Monitor Workflow Services
Decision Table
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Run Program Process

This action lists custom actions associated with all the available loyalty program processes. You can trigger an active loyalty program process using its corresponding custom invocable action.

This action is available in API version 56.0 and later.

Supported REST HTTP Methods

URI
/services/data/v56.0/actions/custom/runProgramProcess/<actionName>

<actionname> is the name of a Loyalty Program Process setup action that an admin creates in a Salesforce org.

Note

Formats
JSON
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Vary depending on the Loyalty Program Process setup action.

Outputs

Standard invocable action result parameters, such as isSuccess and errors along with other parameters that vary depending on the inputs.

Output Details
errors
Type
List<String>
Description
A list of error messages if the operation fails.
isSuccess
Type
Boolean
Description
Indicates whether the operation is successful or not.

Examples

This section has the sample request and response for triggering the Credit Points Program Process.

Sample Resource
/services/data/v56.0/actions/custom/runProgramProcess/NTO_SLI_CreditPoints
Sample request

Here’s an example POST request that has the inputs, such as, Loyalty Program member ID, points to credit, and other transaction details:

Sample response

Here’s an example response of a successful credit points program operation: