Zoom Batch Register Meeting Attendees

arazzo: 1.0.1
info:
  title: Zoom Batch Register Meeting Attendees
  summary: Add a batch of registrants to a meeting and confirm the roster.
  description: >-
    Registers a batch of attendees for a meeting in a single call and then lists
    the meeting registrants to confirm the batch landed. The batch step auto-approves
    the registrants and captures the returned registrant collection, and the list
    step reads back the approved roster. Every request is spelled out inline so the
    flow can be read and executed without opening the underlying OpenAPI
    description.
  version: 1.0.0
sourceDescriptions:
- name: meetingRegistrantsApi
  url: ../openapi/zoom-meeting-registrants-api-openapi.yml
  type: openapi
workflows:
- workflowId: batch-register-attendees
  summary: Batch-register attendees for a meeting and confirm the roster.
  description: >-
    Calls batchAddMeetingRegistrants to enroll up to thirty attendees at once, then
    listMeetingRegistrants to confirm the approved roster.
  inputs:
    type: object
    required:
    - accessToken
    - meetingId
    - registrants
    properties:
      accessToken:
        type: string
        description: OAuth bearer access token for the Zoom REST API.
      meetingId:
        type: string
        description: The meeting id to register the attendees for.
      registrants:
        type: array
        description: >-
          Up to thirty registrant objects, each with at least an email and
          optional first_name and last_name.
        items:
          type: object
  steps:
  - stepId: batchRegister
    description: >-
      Register the supplied batch of attendees in one call and auto-approve them.
    operationId: batchAddMeetingRegistrants
    parameters:
    - name: Authorization
      in: header
      value: Bearer $inputs.accessToken
    - name: meetingId
      in: path
      value: $inputs.meetingId
    requestBody:
      contentType: application/json
      payload:
        auto_approve: true
        registrants: $inputs.registrants
    successCriteria:
    - condition: $statusCode == 201
    outputs:
      registrants: $response.body#/registrants
  - stepId: listRegistrants
    description: List the approved registrants to confirm the batch was added.
    operationId: listMeetingRegistrants
    parameters:
    - name: Authorization
      in: header
      value: Bearer $inputs.accessToken
    - name: meetingId
      in: path
      value: $inputs.meetingId
    - name: status
      in: query
      value: approved
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      totalRecords: $response.body#/total_records
      roster: $response.body#/registrants
  outputs:
    addedRegistrants: $steps.batchRegister.outputs.registrants
    totalRecords: $steps.listRegistrants.outputs.totalRecords