openapi: 3.2.0
info:
  title: DeBounce Bulk Email Validation Upload API
  description: Bulk email list upload and status checking endpoints.
  license:
    name: MIT
  version: 1.0.0
servers:
- url: https://bulk.debounce.io
security:
- ApiKeyQuery: []
tags:
- name: Upload
paths:
  /v1/upload/:
    get:
      summary: Perform bulk email validation
      description: Perform a bulk email validation request via API.
      operationId: uploadBulkList
      parameters:
      - name: api
        in: query
        description: Your DeBounce API key
        required: true
        schema:
          type: string
      - name: url
        in: query
        description: URL of your .csv or .txt email list, starting with https and uploaded in your server.
        required: true
        schema:
          type: string
          format: uri
      responses:
        '200':
          description: Bulk upload accepted and processing started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkUploadResult'
              examples:
                success:
                  summary: Successful bulk validation upload
                  value:
                    debounce:
                      list_id: '8620'
                      list_name: test-list
                    success: '1'
                maxReqs-reached:
                  summary: Maximum bulk verify requests reached
                  value:
                    debounce:
                      error: You have reached the maximum number of API bulk verify requests. Please try after the existing request completes.
                    success: '0'
        '400':
          description: Bad request - Invalid URL or file format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                debounce:
                  error: URL parameter is not valid.
                success: '0'
        '401':
          description: Unauthorized - Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                debounce:
                  error: Wrong API
                  code: '0'
                success: '0'
        '402':
          description: Payment Required - Insufficient credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                debounce:
                  error: You have exhausted your credits, please add additional credits to continue.
                success: '0'
        '429':
          description: Too Many Requests - Maximum concurrent calls reached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                debounce:
                  error: Maximum concurrent calls reached
                success: '0'
      tags:
      - Upload
components:
  schemas:
    BulkUploadResult:
      type: object
      required:
      - success
      properties:
        debounce:
          type: object
          properties:
            list_id:
              description: Unique identifier for the uploaded list
              type: string
            list_name:
              description: Name of the uploaded list
              type: string
        success:
          description: Whether the upload was successful
          type: string
          enum:
          - '0'
          - '1'
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
        message:
          type: string
        debounce:
          type: object
          properties:
            error:
              type: string
            code:
              type: string
        success:
          type: string
          enum:
          - '0'
  securitySchemes:
    ApiKeyQuery:
      type: apiKey
      in: query
      name: api
      description: API key for authentication