RingCentral Events Registrations API

openapi: 3.0.3
info:
  title: RingCentral Events Bank Questions Registrations API
  description: The RingCentral Events External API provides programmatic access to manage organizations, events, sessions, stages, booths, registrations, tickets, magic links, reports, schedule items, tags, and data subscriptions. Authentication uses OAuth 2.0 with client credentials. API access is restricted to the Enterprise plan.
  version: 1.0.0
  contact:
    name: RingCentral Events Developer Support
    url: https://developer.events.ringcentral.com/
  license:
    name: Proprietary
  termsOfService: https://developer.events.ringcentral.com/external-api
servers:
- url: https://api.events.ringcentral.com
  description: RingCentral Events Production API
tags:
- name: Registrations
  description: Event registration management
paths:
  /v1/events/{eventId}/registrations:
    get:
      summary: Retrieve the list of registrations for an Event
      operationId: Retrieve_the_list_of_registrations_for_an_Event
      description: Retrieve the list of registrations for an Event
      tags:
      - Registrations
      parameters:
      - name: eventId
        in: path
        required: true
        schema:
          type: string
        description: eventId identifier
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '429':
          description: Too Many Requests
      security:
      - oauth2:
        - read
    post:
      summary: Create a registration for event
      operationId: Create_a_registration_for_event
      description: You can only update \`metadata\` for Registrations
      tags:
      - Registrations
      parameters:
      - name: eventId
        in: path
        required: true
        schema:
          type: string
        description: eventId identifier
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '429':
          description: Too Many Requests
        '201':
          description: Created
      security:
      - oauth2:
        - read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              data:
                type: registration
                attributes:
                  answers:
                  - questionId: string
                    answer: string
                  email: string
                  externalBarcode: string
                  firstName: string
                  lastName: string
                  metadata: {}
                  ticketId: string
  /v1/registrations/{registrationId}:
    patch:
      summary: Update registration
      operationId: Update_registration
      description: You can only update \`metadata\` for Registrations
      tags:
      - Registrations
      parameters:
      - name: registrationId
        in: path
        required: true
        schema:
          type: string
        description: registrationId identifier
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '429':
          description: Too Many Requests
        '201':
          description: Created
      security:
      - oauth2:
        - read
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              data:
                type: registration
                attributes:
                  answers:
                  - questionId: string
                    answer: string
                  externalBarcode: string
                  firstName: string
                  headline: string
                  lastName: string
                  ticketId: string
    get:
      summary: Retrieve registration details
      operationId: Retrieve_registration_details
      description: Retrieve registration details
      tags:
      - Registrations
      parameters:
      - name: registrationId
        in: path
        required: true
        schema:
          type: string
        description: registrationId identifier
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '429':
          description: Too Many Requests
      security:
      - oauth2:
        - read
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 Client Credentials flow
      flows:
        clientCredentials:
          tokenUrl: https://api.events.ringcentral.com/v1/auth/token
          scopes:
            read: Read access to resources
            write: Write access to resources
externalDocs:
  description: RingCentral Events API Documentation
  url: https://developer.events.ringcentral.com/external-api