Invite custom portal users
The purpose of this API is to invite users to a custom portal.
| Request URL: | https://learn.zoho.com/learn/api/v1/portal/<networkurl>/invite |
| OAuth Scope: | ZohoLearn.hubMember.CREATE |
| Request Method: | POST |
| Parameter | Description | Required |
| userlist | [{"emailId": "user1@zylker.com","fname":"user","lname":"one"},{"emailId": "user2@zylker.com","fname":"user","lname":"two"},{"emailId": "user3@zylker.com","fname":"user","lname":"three"}] Here,
| Required |
| mailContent | Mail content to be send. If mailContent parameter value is empty, default mail content will be send. | Optional |
| customPortalId | Custom portal unique ID | Required |
Success response
Copied{
"successUserCount": "2",
"invitedUsers": [
"user1@zylker.com"
],
"alreadyInvitedUsers": [
"user2@zylker.com"
],
"existingUsers": [
"user3@zylker.com"
],
"result": "success"
}Failure response
Copied{
"result": "failure",
"reason": "Exception while inviting user to custom portal"
}