Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Benefit Schedule Sessions Preview (POST)

Create a preview of the benefit scheduling session. Users can preview the benefit sessions before they are created.

Resource

1/connect/program-mgmt/benefit-schedules

Example URI

1https://yourInstance.salesforce.com/services/data/v67.0/connect/program-mgmt/benefit-schedules

Available version

57.0

HTTP methods

POST

Request body for POST

Root XML tag

<PreviewBenefitSessionInputRepresentation>

JSON example

1{
2  "benefitScheduleName": "Nov Weekday schedule",
3  "firstSessionStartDate": "2022-11-14T14:30:00.000",
4  "firstSessionEndDate": "2022-11-14T15:00:00.000",
5  "scheduleFrequency": "Weekly",
6  "scheduleDays": 96,
7  "mode": "dryRun",
8  "noOfSessions": 5,
9  "totalRecurrencesCount": 10
10}

Properties

Name	Type	Description	Required or Optional	Available Version
`benefitScheduleName`	String	The name of the benefit schedule.	Required	57.0
`firstSessionEndDate`	String	The date and time when the first session ends in the benefit schedule.	Required	57.0
`firstSessionStartDate`	String	The date and time when the first session starts in the benefit schedule.	Required	57.0
`mode`	String	The mode of the benefit schedule. The `dryRun` mode indicates that no data is created.	Optional	57.0
`noOfSessions`	Integer	The maximum number of participants in a session. Default value is 5.	Optional	57.0
`scheduleDays`	Integer	The number of days in a week when the benefit schedule is executed.	Optional	57.0
`scheduleEndDate`	String	The date when the benefit schedule ends.	Optional	57.0
`scheduleFrequency`	String	The frequency at which the benefit schedule is executed.	Optional	57.0
`totalRecurrencesCount`	Integer	The number of times the benefit schedule is executed.	Optional	57.0

Response body for POST

Preview Benefit Sessions Output

Nonprofit Cloud Developer Guide

Benefit Schedule Sessions Preview (POST)