Webinar Registrants Swagger Open Schema

webinar_registrants_status_schema.json

{
  "x-stoplight": {
    "docs": {
      "showModels": false,
      "includeDownloadLink": true
    }
  },
  "swagger": "2.0",
  "info": {
    "title": "Zoom API",
    "description": "The Zoom API allows developers to access information from Zoom. You can use this API to build private services or public applications on the [Zoom App Marketplace](http://marketplace.zoom.us). To learn how to get your credentials and create private/public applications, read our [Authorization Guide](https://marketplace.zoom.us/docs/guides/authorization/credentials).\nAll endpoints are available via `https` and are located at `api.zoom.us/v2/`.\n\nFor instance you can list all users on an account via `https://api.zoom.us/v2/users/`.",
    "contact": {
      "name": "Zoom Developers",
      "url": "https://developer.zoom.us/",
      "email": "developersupport@zoom.us"
    },
    "license": {
      "name": "MIT for OAS 2.0",
      "url": "https://opensource.org/licenses/MIT"
    },
    "version": "2.0.0",
    "termsOfService": "https://zoom.us/docs/en-us/zoom_api_license_and_tou.html"
  },
  "host": "api.zoom.us",
  "basePath": "/v2",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json",
    "multipart/form-data"
  ],
  "produces": [
    "application/json",
    "application/xml"
  ],
  "paths": {
    "/webinars/{webinarId}/registrants/status": {
      "put": {
        "summary": "Update Webinar Registrant Status",
        "description": "Update a webinar registrant's status. Using this API, you can specify whether you want to approve a registration, deny a registration or cancel a previously approved registration.<br><br>\n**Scopes:** `webinar:write:admin` `webinar:write`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br>\n\n",
        "tags": [
          "Webinars"
        ],
        "operationId": "webinarRegistrantStatus",
        "parameters": [
          {
            "in": "path",
            "name": "webinarId",
            "description": "The webinar ID in \"**long**\" format(represented as int64 data type in JSON). ",
            "type": "integer",
            "required": true,
            "format": "int64"
          },
          {
            "in": "query",
            "name": "occurrence_id",
            "description": "The meeting occurrence ID.",
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "required": true,
            "schema": {
              "type": "object",
              "properties": {
                "action": {
                  "type": "string",
                  "enum": [
                    "approve",
                    "cancel",
                    "deny"
                  ],
                  "x-enum-descriptions": [
                    "Approve registrant",
                    "Cancel registrant",
                    "Deny registrant"
                  ],
                  "description": "Used to approve a registrant, deny a registrant, or cancel a previously approved registrant. "
                },
                "registrants": {
                  "type": "array",
                  "description": "List of registrants.",
                  "maximum": 30,
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Registrant ID"
                      },
                      "email": {
                        "type": "string",
                        "description": "Registrant's email address."
                      }
                    }
                  }
                }
              },
              "required": [
                "action"
              ]
            },
            "x-examples": {
              "application/json": {
                "action": "string",
                "registrants": [
                  {
                    "id": "string",
                    "email": "string"
                  }
                ]
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "**HTTP Status Code:** `200`<br>\nThe webinar plan subscription is missing. Enable webinar for this user once the subscription is added: {userId}."
          },
          "300": {
            "description": "**HTTP Status Code:** `300`<br>Invalid webinar ID."
          },
          "400": {
            "description": "**HTTP Status Code:** `400`<br>\nBad request<br>\n**Error Code:** `1010`<br>\nUser does not belong to this account:{accountId}.<br>\n**Error Code:** `3035`<br>\nWebinar has reached maximum attendee capacity.<br>"
          },
          "404": {
            "description": "**HTTP Status Code:** `404`<br>\nWebinar not found.<br>\n**Error Code:** `1001`<br>\nUser {userId} does not exist or does not belong to this account.<br>\n**Error Code:** `3001`<br>\nWebinar {webinarId} not found or has expired.<br>"
          }
        },
        "security": [
          {
            "OAuth": []
          }
        ]
      }
    }
  },
  "securityDefinitions": {
    "OAuth": {
      "type": "oauth2",
      "flow": "accessCode",
      "authorizationUrl": "https://zoom.us/oauth/authorize",
      "tokenUrl": "https://zoom.us/oauth/token"
    },
    "Bearer": {
      "type": "apiKey",
      "name": "Authorization",
      "in": "header"
    },
    "Client Credentials": {
      "type": "oauth2",
      "flow": "application",
      "tokenUrl": "https://api.zoom.us/oauth/token",
      "description": "Client Credentials Flow for ChatBots"
    }
  },
  "security": [
    {
      "OAuth": []
    }
  ]
}