The Online Programs Participants API manages member enrollment and progress tracking in online programs. Use this API to create participants, retrieve their learning progress, manage their enrollment, and issue certificates.
Each participant belongs to a single program and represents one site's member enrollment in that program. A member can participate in multiple programs. When a participant is created through the Join Applications API, it has the same ID as the corresponding join application. Deleting that participant also deletes the corresponding join application.
With the Online Programs Participants API, you can:
- Create participants in online programs with different pricing types, including free enrollment, a single payment, a paid plan, or a free coupon.
- Retrieve calculated participant progress through program steps and sections.
- Suspend and resume participant enrollment.
- Issue certificates to eligible participants and retrieve certificate download URLs.
- Perform bulk operations for efficient participant management.
- Search and filter participants using various criteria.
- Retrieve site-wide participation statistics for one or more programs.
To learn more about online programs and their structure, see the Online Programs API.
It's important to note the following points before starting to code:
- Premium plans are required to exceed the free tier participant limits for your site.
- The progress field is expensive to calculate and must be explicitly requested using the
PROGRESS field parameter.
- A
programId is required when creating a participant and can't be changed later. The program defines the available enrollment options, visibility, and timeline settings.
- Bulk Create Participants accepts up to 100 participants for the same program. Bulk Create Participants for All Members is asynchronous.
- A certificate can be issued only when the program has a configured certificate reward. A site member can issue a certificate only after completing the program.
Learn how the Online Programs Participants API can support these use cases:
- Participant: A site member who is enrolled in a specific online program and has access to its content.
- Pricing type: How the member enrolled in the program, such as free enrollment, a single payment, a paid plan, or a free coupon.
- Progress: The participant's calculated completion data, including completed and available steps and completion percentage.
- Enrollment status: Whether the participant is enrolled, suspended, removed, or has left the program.
- Progress status: Whether the participant hasn't started, is in progress, completed, failed, or is no longer eligible for progress tracking.
- Certificate: A completion credential that can be issued to participants who finish programs with certificate rewards.
- Member snapshot: Member information stored with the participant.
- Bulk operations: Efficient methods for managing multiple participants simultaneously with specific limits and constraints.