Program Enrollments (PUT)

Update program enrollments.

Resource

1/connect/program-mgmt/programs/${programId}/enrollments

Example URI for PUT

1https://yourInstance.salesforce.com/services/data/v62.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

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

1{
2  "enrollees": {
3    "enrolleeList": [
4      {
5        "id": "11Xxx0000004Gz5EAE",
6        "status": "Enrolled",
7        "endDate": "2025-05-11T13:05:23.000Z"
8      },
9      {
10        "id": "11Xxx0000004Gz6EAE",
11        "status": "Enrolled",
12        "startDate": "2023-02-11T13:05:23.000Z",
13        "endDate": "2024-01-12T13:05:23.000Z"
14      },
15      {
16        "id": "11Xxx0000004Gz7EAE",
17        "status": "Enrolled",
18        "startDate": "2023-02-11T13:05:23.000Z",
19        "applicationDate": "2023-02-11T13:05:23.000Z"
20      },
21      {
22        "id": "11Xxx0000004Gz9EAE",
23        "status": "Enrolled",
24        "endDate": "2024-01-11T13:05:23.000Z",
25        "applicationDate": "2023-02-12T13:05:23.000Z"
26      }
27    ]
28  }
29}

Response body for PUT

Program Enrollments Output

Nonprofit Cloud Developer Guide

Program Enrollments (PUT)