To add or remove user to or from a course in a custom portal
The purpose of this API is to add/remove users to/from a course in a custom portal.
| Request URL: | https://learn.zoho.com/learn/api/v1/portal/<networkurl>/customportal/<customportalId>/course/<courseid> |
| OAuth Scope: | ZohoLearn.customportal.UPDATE |
| Request Method: | PUT |
| Request Body: | { "isPublic": <boolean>, "resetStats": <boolean>, "enrollmentType": "PRIVATE|PUBLIC|ON_REQUEST", "addedZuids": <array of zuids>,(optional) "removedZuids": <array of zuids> (optional) } |
| Request Body Keys | Description | Required |
| enrollmentType | PRIVATE - Only zuids added to the course can take this course. PUBLIC - Anyone from the custom portal can enroll to this course. ON_REQUEST - Anyone from the custom portal can view the preview of this course but requires admin's approval to enroll to the course. | Optional |
| isPublic | In case of public custom portal set this value to true to show a public preview of this course. | Optional |
| addedZuids | Comma separated zuids of custom portal users to be added to this course. | Optional |
| removedZuids | Comma separated zuids of custom portal users to be removed from this course. | Optional |
| resetStats | If sent true, learner statistics of the removedZuids will be removed. | Optional |
Sample response
Copied{"STATUS":"OK"}