Nonprofit Cloud Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Program Enrollments (PUT)
- Resource
-
/connect/program-mgmt/programs/${programId}/enrollments - Example URI for PUT
-
https://yourInstance.salesforce.com/services/data/v63.0/connect/program-mgmt/programs/11Wxx0000004F3kEAE/enrollments - Available version
- 57.0
- HTTP methods
- PUT
- Request body for PUT
-
- Root XML tag
- <ProgramEnrollmentsInputRepresentation>
- Properties
-
Name Type Description Required or Optional Available Version enrollees Program Enrollment Input[] The list of program enrollments that need to be added or updated.
For POST, the enrollments you want to add can either be a contact or an account.
For PUT, specify the program enrollments that need to be updated.
Required 57.0
-
- JSON example
-
{ "enrollees": { "enrolleeList": [ { "id": "11Xxx0000004Gz5EAE", "status": "Enrolled", "endDate": "2025-05-11T13:05:23.000Z" }, { "id": "11Xxx0000004Gz6EAE", "status": "Enrolled", "startDate": "2023-02-11T13:05:23.000Z", "endDate": "2024-01-12T13:05:23.000Z" }, { "id": "11Xxx0000004Gz7EAE", "status": "Enrolled", "startDate": "2023-02-11T13:05:23.000Z", "applicationDate": "2023-02-11T13:05:23.000Z" }, { "id": "11Xxx0000004Gz9EAE", "status": "Enrolled", "endDate": "2024-01-11T13:05:23.000Z", "applicationDate": "2023-02-12T13:05:23.000Z" } ] } }
- Response body for PUT
- Program Enrollments Output