PATCH

Update Participant


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a participant's enrollment status or enrollment pricing details.

Each time the participant is updated, revision increments by 1. The current revision must be passed when updating the participant. This ensures you're working with the latest participant and prevents unintended overwrites.

Use this method to suspend or resume a participant by setting enrollmentStatus to SUSPENDED or JOINED. To remove a participant, use DeleteParticipant. Progress status is calculated from the participant's resolved steps and can't be updated.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Online Programs
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/online-programs/v3/participants/{participant.id}

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Event TriggersThis method triggers the following events:
Did this help?