Nonprofit Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to Nonprofit Cloud
Nonprofit Cloud Data Model
Fundraising
Program Management
Program Management Standard Objects
Program Management Business APIs
REST Reference
Resources
Benefit Disbursements (POST)
Benefit Session Participants (POST)
Benefit Schedule Participants (POST)
Benefit Schedule Participants (DELETE)
Benefit Schedule Sessions (POST)
Benefit Schedule Sessions Preview (POST)
Benefit Disbursement Field Set API Names
Case Programs (POST)
Gift Transactions
Gift Transaction Designations
Gift Commitment Transactions
Gift Commitment Default Designations
Gift Campaign Default Designations
Program Enrollments (POST)
Program Enrollments (PUT)
Requests
Responses
Case Management
Outcome Management Standard Objects
Grantmaking
Volunteer Management Standard Objects
Group Memberships and Households in Nonprofit Cloud
Record Rollup Definitions
NonProfit Cloud Associated Objects
PDF

Benefit Schedule Sessions Preview (POST)

Create a preview of the benefit scheduling session. Users can preview the benefit sessions before they are created.
Resource
/connect/program-mgmt/benefit-schedules
Example URI
https://yourInstance.salesforce.com/services/data/v64.0/connect​​/program-mgmt/benefit-schedules
Available version
57.0
HTTP methods
POST
Request body for POST
Root XML tag
<PreviewBenefitSessionInputRepresentation>
JSON example
{
  "benefitScheduleName": "Nov Weekday schedule",
  "firstSessionStartDate": "2022-11-14T14:30:00.000",
  "firstSessionEndDate": "2022-11-14T15:00:00.000",
  "scheduleFrequency": "Weekly",
  "scheduleDays": 96,
  "mode": "dryRun",
  "noOfSessions": 5,
  "totalRecurrencesCount": 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