Nonprofit Cloud Developer Guide

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
Group Memberships and Households in Nonprofit Cloud
NonProfit Cloud Associated Objects
PDF

Newer Version Available

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

Benefit Schedule Participants (POST)

Asynchronously add participants to a benefit schedule.
Resource
1/connect/program-mgmt/benefit-schedules/${benefitScheduleId}/participants
Example URI
1https://yourInstance.salesforce.com/services/data/v62.0/connect​​/program-mgmt/benefit-schedules/${benefitScheduleId}/participants
Available version
57.0
HTTP methods
POST
Request body for POST
Root XML tag
<BenefitScheduleParticipantsInputRepresentation>
JSON example
1{
2  "enrollees": {
3    "enrolleeList": [
4        "003xx000004WhKeAAK"
5    ]
6  }
7}
Properties
Name Type Description Required or Optional Available Version
enrollees String[] The list of enrollees to be added to a benefit schedule. The enrollee can either be a contact, an account, or a program enrollment. Required 57.0
Response body for POST
Benefit Schedule Participants Output