Get registration details - Zoho Webinar

Note:

  • This task is applicable to all services except Zoho Creator.
  • Each time the zoho.webinar.getRegistrationDetails integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
  • Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.webinar.getRegistrationDetails integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script. 

Overview:

This task is used to get registration details in Zoho Webinar.

This task is based on the Zoho Webinar API: Registration

Syntax:

<variable> = zoho.webinar.getRegistrationDetails(<portal_id>, <webinar_key>, <sys_Id>, <status>, <index>, <count>, <connection>);

where:

ParamsData typeDescription
<variable>KEY_VALUESpecifies the variable that will hold the response returned by Zoho Webinar.
<portal_Id>NUMBER

Specifies the unique portal identifier where the registration details of the webinar will be fetched from.

Note: Portal_Id can be fetched in the following ways.

  • From the URL of the application while accessing it. The URL is in the format webinar.zoho.com/webinar/portal_Id/department_Id/home
  • Get portal ID from Zoho Webinar API, where ZSOID represents the portal ID.
<webinar_key>NUMBERSpecifies the unique key identifier of the webinar registration details.
<sys_Id>NUMBERSpecifies the recurring webinar ID.
<status>INTEGER

Specifies the registration status of the webinar.

Supported registration status:
1 > Auto approval
0 > Manual approval
2 > Approval denied by organizer
3 > Canceled done by registrant via mail

<index>INTEGERSpecifies the pagination start index. Default: 1.
<count>INTEGERSpecifies the number of registration details to fetch.
<connection>TEXT

Specifies the link name of the Zoho Webinar connection.

Required scope for this API connection: ZohoWebinar.registration.READ

Example:

rsponse = zoho.webinar.getRegistrationDetails(86367739,1049243583,645551000000038094,1,1,20,"webinar");

where:

response
Is the KEY-VALUE returned by Zoho Webinar. It represents the webinar details.
86367739
Is the NUMBER of the unique portal identifier where the registration details of the webinar will be fetched from.
1049243583
Is the NUMBER of the unique key identifier of the webinar registration details.
645551000000038094
Is the NUMBER that specifies the recurring webinar ID.
1
Is the INTEGER of registration status of the webinar.
1
Is the INTEGER of pagination start index. Default: 1.
20
Is the INTEGER of number of registration details to fetch.
"webinar"
Is the TEXT that represents the name of the connection.

Sample response

Success response

The success response returned is in the following format.

{
  "registrants": [
    {
      "approvalStatus": "1",
      "registerKey": "e7d91dce6427c02f1f1d2b83e962b1dc3b09ab05b868a211ac9b8b5feda8b5e9",
      "registeredTimeInMilliSec": 1765350840000,
      "regionName": "",
      "registrationCustomizedAnswers": {},
      "joinLink": "https://webinar.zoho.com/meeting/register/join?registerKey=e7d91dce6427c02f1f1d2b83e962b1dc3b09ab05b868a211ac9b8b5feda8b5e9&sessionId=1049243583&uname=prahana+prahana+test",
      "userName": "prahana prahana test",
      "registeredTime": "Dec 10, 2025 12:44 PM IST",
      "registerId": "645551000000038166",
      "countryName": "unknown",
      "registeredTimezone": "Asia/Calcutta",
      "email": "prahana.m+11@zohotest.com",
      "status": "Accepted"
    }
  ],
  "meta": {
    "deniedCount": 0,
    "pendingCount": 0,
    "isAutoApprovalEnabled": true,
    "totalCount": 3,
    "approvedCount": 3
  }
}
 

Failure response

{
  "error": {
    "errorCode": 4000,
    "message": "The meeting key is invalid.",
    "key": "INVALID_MEETING_KEY"
  }
}