Nonprofit Cloud Developer Guide

Introduction to Nonprofit Cloud
Nonprofit Cloud Data Model
Case Management
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)
Request Bodies
Response Bodies
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 (DELETE)

Remove participants from a benefit schedule asynchronously.

Removing a participant from a benefit schedule:

  • Updates the end date of all the active benefit schedule assignments associated with the participant to a current date.
  • Deletes benefit disbursements for future sessions whose attendance is yet to be marked.
Resource
1/connect/program-mgmt/benefit-schedules/${benefitScheduleId}/benefit-assignments
Resource example
1https://yourInstance.salesforce.com/services/data/v60.0/connect/program-mgmt/benefit-schedules/BS-000000006/benefit-assignments?ids=BA-000000001,BA-000000002
Available version
59.0
HTTP methods
DELETE
Query parameters for DELETE
Parameter Name Type Description Required or Optional Available Version
ids String[] Valid IDs of benefit assignments related to the participants to be removed.

You can provide a maximum of 100 IDs.

 Required 59.0