Invite users to hub

The purpose of this API to invite users to a hub.

Request URL:https://learn.zoho.com/learn/api/v1/hubs/<hubUrl>/invite
OAuth Scope:ZohoLearn.hubMember.CREATE
Request Method:POST
ParameterDescription 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,

  • The input parameter should be formatted as a JSON array containing multiple objects.
  • emailId should be a valid email of the user.
  • fname stands for first name and is optional.
  • Iname stands for last name and is optional.
  • Only 100 emails can be invited at a time.
Required
mailContent

Mail content that has to be sent.

  • The input parameter type is String.
  • If mailContent parameter value is empty, default mail content will be send.
Optional

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 users to hub"
}