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 the custom action associated with an active loyalty program process. The custom action name consists of the name of the loyalty program that the process belongs to followed by a delimiter, and then the name of the process. The delimiter is SLI. The program name, the delimiter, and the process name are seperated by underscores. If your loyalty program and process names have spaces, the spaces are replaced with underscores.

If the name of your loyalty program is InnerCircle and process name is Issue Voucher, then the action name is InnerCircle_SLI_Issue_Voucher. If the name of your loyalty program is Inner Circle and process name is IssueVoucher, then the action name is Inner_Circle_SLI_IssueVoucher.

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	Type	Description
`errors`	List<String>	A list of error messages if the operation fails.
`isSuccess`	Boolean	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:

1{
2  "inputs": [
3    {
4      "TransactionJournal": {
5        "ActivityDate": "2022-11-27T00:00:00Z",
6        "BookingDate": "2022-10-23",
7        "EndDate": "2022-10-23T00:00:00Z",
8        "ExternalTransactionNumber": "1",
9        "InvoiceDate": "2022-10-23",
10        "JournalTypeName": "Accrual",
11        "JournalSubTypeName": "xyz",
12        "LoyaltyProgramId": "0lpRM0000004D53YAE",
13        "MemberId": "0lMRM0000004Eqv2AE",
14        "TransactionAmount": 45,
15        "Status": "Processed"
16      },
17      "PointsToCredit": "100"
18    }
19  ]
20}

Sample response

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

1{
2  "actionName": "NTO_SLI_CreditPoints",
3  "errors": null,
4  "isSuccess": true,
5  "outputValues": {
6    "PointsCredited": 100
7  }
8}