> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # UpdateParticipant # Package: onlinePrograms # Namespace: ParticipantsService # Method link: https://dev.wix.com/docs/api-reference/business-management/online-programs/participants/update-participant.md ## Permission Scopes: Manage Online Programs: SCOPE.CHALLENGES.MANAGE ## Introduction 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. --- ## REST API ### Schema ``` Method: updateParticipant Description: 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. URL: https://www.wixapis.com/online-programs/v3/participants/{participant.id} Method: PATCH # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: participant, participant.id, participant.revision Method parameters: param name: fields | type: array | description: Array of conditional fields to include in the response. Use `RequestedFields.PROGRESS` to include the `progress` field, which isn't returned by default. | validation: maxItems 1 - enum: - PROGRESS: Request the progress field to be calculated and included in the response. param name: participant | type: Participant | description: A participant entity represents a site member who takes part in a specific Online Program. Participants have access to the program's content and progress through the program by completing its steps. A participant can join through a join application flow or be manually added by the program owner. A participant's status depends on their progress and the program's settings (e.g., start and end dates). Participation may also be temporarily suspended. | required: true - name: id | type: string | description: Participant GUID. | required: true | read-only: true | validation: format GUID - name: revision | type: string | description: Revision number, which increments by 1 each time the participant is updated. To prevent conflicting changes, the current revision must be specified when updating the participant. Ignored when creating a participant. | required: true | read-only: true | validation: format int64 - name: enrollmentInfo | type: EnrollmentInfo | description: Additional information about the participant's enrollment and completion timeframe in the program. - ONE-OF: - name: singlePaymentDetails | type: SinglePaymentDetails | description: Details about a Single Payment enrollment. - name: paymentOrderId | type: string | description: GUID of the cashier order which was used to pay for joining the program. | validation: format GUID, immutable - name: offlineTransactionId | type: string | description: GUID of the offline transaction. Available only when the participant paid with an offline payment method, such as cash or check. | validation: format GUID, immutable - name: paidPlanDetails | type: PaidPlanDetails | description: Details about a Paid Plan enrollment. - name: paidPlanId | type: string | description: GUID of the Paid Plan for which member has paid to join the program. | validation: format GUID, immutable - name: freeCouponDetails | type: FreeCouponDetails | description: Details about a Free Coupon enrollment. - name: freeCouponId | type: string | description: GUID of the coupon which was applied and gave 100% discount to join the program for free. | validation: format GUID, immutable - name: pricingType | type: PricingType | description: Pricing type used for the participant's enrollment in the program. - enum: - FREE: Member joined a program that is configured as free to join, with no payment required. - ADDED_MANUALLY: Member was added to the program by site owner. - SINGLE_PAYMENT: Member paid once to join the program. - PAID_PLAN: Member joined using a Pricing Plan. - FREE_COUPON: Member joined a paid program using a coupon that provided 100% discount. - name: extendedFields | type: ExtendedFields | description: Custom field data for the participant object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). | validation: format map - name: tags | type: Tags | description: Tags for categorizing and organizing participants. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, typically restricted from site members and visitors. - name: tagIds | type: array | description: List of tag GUIDs. | validation: maxItems 100, maxLength 5 - name: publicTags | type: TagList | description: Tags that are exposed to anyone with access to the entity, including site members and visitors. Return type: UpdateParticipantResponse - name: participant | type: Participant | description: Updated participant. - name: id | type: string | description: Participant GUID. | read-only: true | validation: format GUID - name: revision | type: string | description: Revision number, which increments by 1 each time the participant is updated. To prevent conflicting changes, the current revision must be specified when updating the participant. Ignored when creating a participant. | read-only: true | validation: format int64 - name: createdDate | type: string | description: Date and time the participant was created. | read-only: true | validation: format date-time - name: updatedDate | type: string | description: Date and time the participant was updated. | read-only: true | validation: format date-time - name: memberId | type: string | description: Member GUID of the participant on the site. | read-only: true | validation: format GUID - name: programId | type: string | description: GUID of the program the participant is enrolled in. | read-only: true | validation: format GUID - name: progress | type: Progress | description: Program completion progress. This field is conditional and must be explicitly requested using the `fields` parameter. | read-only: true - name: totalStepsCompleted | type: integer | description: Number of program steps completed by member. | validation: minimum 0 - name: totalStepsAvailable | type: integer | description: Total number of program steps available to resolve. | validation: minimum 0 - name: completionPercentage | type: number | description: Participant's completion percentage. For participants who completed the program, this is `100.0`. Otherwise, it's calculated as (`totalStepsCompleted` / `totalStepsAvailable`) * 100, capped at `100`, and rounded to 1 decimal place. | validation: minimum 0, maximum 100 - name: certificateInfo | type: CertificateInfo | description: Information about the participant's certificate. Returned only when a certificate has been issued to the participant. | read-only: true - name: issueDate | type: string | description: Date when the certificate was issued (UTC). | read-only: true | validation: format date-time - name: member | type: Member | description: Snapshot of the site member identified by `memberId`, copied from the Members API. It isn't the authoritative member record. | read-only: true - name: firstName | type: string | description: First name of the site member. Returned only when the member has provided it in their profile. | read-only: true | validation: maxLength 1000 - name: lastName | type: string | description: Last name of the site member. Returned only when the member has provided it in their profile. | read-only: true | validation: maxLength 1000 - name: email | type: string | description: Email of the site member. Returned only when the member has provided it in their profile. | read-only: true | validation: format EMAIL - name: contactId | type: string | description: Contact GUID for accessing additional member information with the Contacts API, such as phone numbers, addresses, and custom fields. Returned only when the member has provided this information in their profile. | read-only: true | validation: format GUID - name: nickname | type: string | description: Member nickname. Returned only when the member has provided it in their profile. | read-only: true | validation: maxLength 1000 - name: profileImageUrl | type: string | description: Profile image URL of the site member. | read-only: true | validation: format WEB_URL - name: lastActivityDate | type: string | description: Last activity date of the participant in the program (can either be status change or step resolution). | read-only: true | validation: format date-time - name: enrollmentStatus | type: EnrollmentStatus | description: Participant's enrollment status in the program. | read-only: true - enum: - JOINED: Participant is actively enrolled in the program. - SUSPENDED: Enrollment temporarily suspended due to payment issues. - AUTO_REMOVED: Automatically removed via a Wix Automations workflow. - REMOVED: Removed from the program by the site owner. - LEFT: Participant voluntarily left the program. - name: progressStatus | type: ProgressStatus | description: Participant's progress status in the program. | read-only: true - enum: - NOT_STARTED: Enrolled but no steps completed yet. - IN_PROGRESS: At least one step completed but program not yet finished. - COMPLETED: Participant successfully completed the program. - FAILED: Participant failed to complete the program within the deadline. - NOT_APPLICABLE: Progress tracking isn't applicable because the participant left, was removed, or was auto-removed. - name: enrollmentInfo | type: EnrollmentInfo | description: Additional information about the participant's enrollment and completion timeframe in the program. - ONE-OF: - name: singlePaymentDetails | type: SinglePaymentDetails | description: Details about a Single Payment enrollment. - name: paymentOrderId | type: string | description: GUID of the cashier order which was used to pay for joining the program. | validation: format GUID, immutable - name: offlineTransactionId | type: string | description: GUID of the offline transaction. Available only when the participant paid with an offline payment method, such as cash or check. | validation: format GUID, immutable - name: paidPlanDetails | type: PaidPlanDetails | description: Details about a Paid Plan enrollment. - name: paidPlanId | type: string | description: GUID of the Paid Plan for which member has paid to join the program. | validation: format GUID, immutable - name: freeCouponDetails | type: FreeCouponDetails | description: Details about a Free Coupon enrollment. - name: freeCouponId | type: string | description: GUID of the coupon which was applied and gave 100% discount to join the program for free. | validation: format GUID, immutable - name: timeZone | type: string | description: Time zone of the site when the participant was enrolled in the program, in IANA timezone format (e.g., "America/New_York"). | read-only: true | validation: maxLength 50 - name: startDate | type: string | description: Date when the participant's program timeline begins, in `YYYY-MM-DD` format. If the program's `timeline.startDate` is set, this is that date. Otherwise, it's the local calendar date when the participant is created, based on the site's time zone. | read-only: true | validation: format LOCAL_DATE - name: pricingType | type: PricingType | description: Pricing type used for the participant's enrollment in the program. - enum: - FREE: Member joined a program that is configured as free to join, with no payment required. - ADDED_MANUALLY: Member was added to the program by site owner. - SINGLE_PAYMENT: Member paid once to join the program. - PAID_PLAN: Member joined using a Pricing Plan. - FREE_COUPON: Member joined a paid program using a coupon that provided 100% discount. - name: deadline | type: string | description: Date by which the participant must complete the program, in `YYYY-MM-DD` format. Returned only when the program has a fixed end date, or a duration-based deadline calculated from the participant's start date. | read-only: true | validation: format LOCAL_DATE - name: extendedFields | type: ExtendedFields | description: Custom field data for the participant object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). | validation: format map - name: tags | type: Tags | description: Tags for categorizing and organizing participants. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, typically restricted from site members and visitors. - name: tagIds | type: array | description: List of tag GUIDs. | validation: maxItems 100, maxLength 5 - name: publicTags | type: TagList | description: Tags that are exposed to anyone with access to the entity, including site members and visitors. ``` ### Examples ### Update participant status Updates a participant's enrollment status to suspended ```curl curl -X PATCH \ 'https://www.wixapis.com/online-programs/participants/v3/participants/f5b74327-4e94-4d42-a214-03e7f1f805ef' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{ "participant": { "id": "f5b74327-4e94-4d42-a214-03e7f1f805ef", "revision": "1", "enrollmentStatus": "SUSPENDED" }, "fields": ["PROGRESS"] }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.onlinePrograms.participants.updateParticipant(_id, participant, options) Description: 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. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: participant, _id, participant.revision Method parameters: param name: _id | type: string | description: Participant GUID. | required: true | validation: format GUID param name: options | type: UpdateParticipantOptions none - name: fields | type: array | description: Array of conditional fields to include in the response. Use `RequestedFields.PROGRESS` to include the `progress` field, which isn't returned by default. | validation: maxItems 1 - enum: - PROGRESS: Request the progress field to be calculated and included in the response. param name: participant | type: UpdateParticipant | description: A participant entity represents a site member who takes part in a specific Online Program. Participants have access to the program's content and progress through the program by completing its steps. A participant can join through a join application flow or be manually added by the program owner. A participant's status depends on their progress and the program's settings (e.g., start and end dates). Participation may also be temporarily suspended. | required: true - name: revision | type: string | description: Revision number, which increments by 1 each time the participant is updated. To prevent conflicting changes, the current revision must be specified when updating the participant. Ignored when creating a participant. | required: true | read-only: true | validation: format int64 - name: enrollmentInfo | type: EnrollmentInfo | description: Additional information about the participant's enrollment and completion timeframe in the program. - ONE-OF: - name: singlePaymentDetails | type: SinglePaymentDetails | description: Details about a Single Payment enrollment. - name: paymentOrderId | type: string | description: GUID of the cashier order which was used to pay for joining the program. | validation: format GUID, immutable - name: offlineTransactionId | type: string | description: GUID of the offline transaction. Available only when the participant paid with an offline payment method, such as cash or check. | validation: format GUID, immutable - name: paidPlanDetails | type: PaidPlanDetails | description: Details about a Paid Plan enrollment. - name: paidPlanId | type: string | description: GUID of the Paid Plan for which member has paid to join the program. | validation: format GUID, immutable - name: freeCouponDetails | type: FreeCouponDetails | description: Details about a Free Coupon enrollment. - name: freeCouponId | type: string | description: GUID of the coupon which was applied and gave 100% discount to join the program for free. | validation: format GUID, immutable - name: pricingType | type: PricingType | description: Pricing type used for the participant's enrollment in the program. - enum: - FREE: Member joined a program that is configured as free to join, with no payment required. - ADDED_MANUALLY: Member was added to the program by site owner. - SINGLE_PAYMENT: Member paid once to join the program. - PAID_PLAN: Member joined using a Pricing Plan. - FREE_COUPON: Member joined a paid program using a coupon that provided 100% discount. - name: extendedFields | type: ExtendedFields | description: Custom field data for the participant object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). | validation: format map - name: tags | type: Tags | description: Tags for categorizing and organizing participants. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, typically restricted from site members and visitors. - name: tagIds | type: array | description: List of tag GUIDs. | validation: maxItems 100, maxLength 5 - name: publicTags | type: TagList | description: Tags that are exposed to anyone with access to the entity, including site members and visitors. Return type: PROMISE - name: _id | type: string | description: Participant GUID. | read-only: true | validation: format GUID - name: revision | type: string | description: Revision number, which increments by 1 each time the participant is updated. To prevent conflicting changes, the current revision must be specified when updating the participant. Ignored when creating a participant. | read-only: true | validation: format int64 - name: _createdDate | type: Date | description: Date and time the participant was created. | read-only: true - name: _updatedDate | type: Date | description: Date and time the participant was updated. | read-only: true - name: memberId | type: string | description: Member GUID of the participant on the site. | read-only: true | validation: format GUID - name: programId | type: string | description: GUID of the program the participant is enrolled in. | read-only: true | validation: format GUID - name: progress | type: Progress | description: Program completion progress. This field is conditional and must be explicitly requested using the `fields` parameter. | read-only: true - name: totalStepsCompleted | type: integer | description: Number of program steps completed by member. | validation: minimum 0 - name: totalStepsAvailable | type: integer | description: Total number of program steps available to resolve. | validation: minimum 0 - name: completionPercentage | type: number | description: Participant's completion percentage. For participants who completed the program, this is `100.0`. Otherwise, it's calculated as (`totalStepsCompleted` / `totalStepsAvailable`) * 100, capped at `100`, and rounded to 1 decimal place. | validation: minimum 0, maximum 100 - name: certificateInfo | type: CertificateInfo | description: Information about the participant's certificate. Returned only when a certificate has been issued to the participant. | read-only: true - name: issueDate | type: Date | description: Date when the certificate was issued (UTC). | read-only: true - name: member | type: Member | description: Snapshot of the site member identified by `memberId`, copied from the Members API. It isn't the authoritative member record. | read-only: true - name: firstName | type: string | description: First name of the site member. Returned only when the member has provided it in their profile. | read-only: true | validation: maxLength 1000 - name: lastName | type: string | description: Last name of the site member. Returned only when the member has provided it in their profile. | read-only: true | validation: maxLength 1000 - name: email | type: string | description: Email of the site member. Returned only when the member has provided it in their profile. | read-only: true | validation: format EMAIL - name: contactId | type: string | description: Contact GUID for accessing additional member information with the Contacts API, such as phone numbers, addresses, and custom fields. Returned only when the member has provided this information in their profile. | read-only: true | validation: format GUID - name: nickname | type: string | description: Member nickname. Returned only when the member has provided it in their profile. | read-only: true | validation: maxLength 1000 - name: profileImageUrl | type: string | description: Profile image URL of the site member. | read-only: true | validation: format WEB_URL - name: lastActivityDate | type: Date | description: Last activity date of the participant in the program (can either be status change or step resolution). | read-only: true - name: enrollmentStatus | type: EnrollmentStatus | description: Participant's enrollment status in the program. | read-only: true - enum: - JOINED: Participant is actively enrolled in the program. - SUSPENDED: Enrollment temporarily suspended due to payment issues. - AUTO_REMOVED: Automatically removed via a Wix Automations workflow. - REMOVED: Removed from the program by the site owner. - LEFT: Participant voluntarily left the program. - name: progressStatus | type: ProgressStatus | description: Participant's progress status in the program. | read-only: true - enum: - NOT_STARTED: Enrolled but no steps completed yet. - IN_PROGRESS: At least one step completed but program not yet finished. - COMPLETED: Participant successfully completed the program. - FAILED: Participant failed to complete the program within the deadline. - NOT_APPLICABLE: Progress tracking isn't applicable because the participant left, was removed, or was auto-removed. - name: enrollmentInfo | type: EnrollmentInfo | description: Additional information about the participant's enrollment and completion timeframe in the program. - ONE-OF: - name: singlePaymentDetails | type: SinglePaymentDetails | description: Details about a Single Payment enrollment. - name: paymentOrderId | type: string | description: GUID of the cashier order which was used to pay for joining the program. | validation: format GUID, immutable - name: offlineTransactionId | type: string | description: GUID of the offline transaction. Available only when the participant paid with an offline payment method, such as cash or check. | validation: format GUID, immutable - name: paidPlanDetails | type: PaidPlanDetails | description: Details about a Paid Plan enrollment. - name: paidPlanId | type: string | description: GUID of the Paid Plan for which member has paid to join the program. | validation: format GUID, immutable - name: freeCouponDetails | type: FreeCouponDetails | description: Details about a Free Coupon enrollment. - name: freeCouponId | type: string | description: GUID of the coupon which was applied and gave 100% discount to join the program for free. | validation: format GUID, immutable - name: timeZone | type: string | description: Time zone of the site when the participant was enrolled in the program, in IANA timezone format (e.g., "America/New_York"). | read-only: true | validation: maxLength 50 - name: startDate | type: string | description: Date when the participant's program timeline begins, in `YYYY-MM-DD` format. If the program's `timeline.startDate` is set, this is that date. Otherwise, it's the local calendar date when the participant is created, based on the site's time zone. | read-only: true | validation: format LOCAL_DATE - name: pricingType | type: PricingType | description: Pricing type used for the participant's enrollment in the program. - enum: - FREE: Member joined a program that is configured as free to join, with no payment required. - ADDED_MANUALLY: Member was added to the program by site owner. - SINGLE_PAYMENT: Member paid once to join the program. - PAID_PLAN: Member joined using a Pricing Plan. - FREE_COUPON: Member joined a paid program using a coupon that provided 100% discount. - name: deadline | type: string | description: Date by which the participant must complete the program, in `YYYY-MM-DD` format. Returned only when the program has a fixed end date, or a duration-based deadline calculated from the participant's start date. | read-only: true | validation: format LOCAL_DATE - name: extendedFields | type: ExtendedFields | description: Custom field data for the participant object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). | validation: format map - name: tags | type: Tags | description: Tags for categorizing and organizing participants. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, typically restricted from site members and visitors. - name: tagIds | type: array | description: List of tag GUIDs. | validation: maxItems 100, maxLength 5 - name: publicTags | type: TagList | description: Tags that are exposed to anyone with access to the entity, including site members and visitors. ``` ### Examples ### Suspend a participant Suspends a participant's enrollment. ```javascript import { participants } from "@wix/online-programs"; async function updateParticipant() { const response = await participants.updateParticipant( "43db0e8d-4392-42d8-b3a6-56d412eb71e0", { _id: "43db0e8d-4392-42d8-b3a6-56d412eb71e0", revision: "1", enrollmentStatus: "SUSPENDED", }, ); return response; } /* Promise resolves to: * { * "_id": "43db0e8d-4392-42d8-b3a6-56d412eb71e0", * "revision": "2", * "enrollmentStatus": "SUSPENDED", * "progressStatus": "NOT_STARTED" * } */ ``` ### updateParticipant (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { participants } from '@wix/online-programs'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { participants }, // Include the auth strategy and host as relevant }); async function updateParticipant(_id,participant,options) { const response = await myWixClient.participants.updateParticipant(_id,participant,options); }; ``` ---