> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Bulk delete email-only users

> Delete up to 100 [email-only users](/administration/users/email-only) in a single request, identified by ID, by email, or a mix of both. Deleting an email-only user also removes them as a recipient from every schedule they receive.

If a request includes unknown or previously-deleted users, these users will be reported as `notFound` without blocking the rest of the request. 

Use the [Delete users](/api/users/delete-user) endpoint to delete standard users and [Delete embed users](/api/users/delete-embed-user) to delete embed users.




## OpenAPI

````yaml /api/openapi.yaml delete /v1/users/email-only/bulk
openapi: 3.1.0
info:
  title: Omni API
  description: >
    The Omni REST API provides programmatic access to your Omni instance for
    managing users, documents, queries, schedules, and more.  
  version: 1.0.0
  contact:
    name: Omni Support
    url: https://docs.omni.co
servers:
  - url: https://{instance}.omniapp.co/api
    description: Production
    variables:
      instance:
        default: blobsrus
        description: Your production Omni instance subdomain
  - url: https://{instance}.playground.exploreomni.dev/api
    description: Playground
    variables:
      instance:
        default: blobsrus
        description: Your playground Omni instance subdomain
security:
  - bearerAuth: []
  - orgApiKey: []
tags:
  - name: Who Am I
    description: Inspect your own user permissions
  - name: AI
    description: AI-powered query generation
  - name: AI Credit Controls
    description: Manage organization-level AI credit usage
  - name: AI Credit Usage
    description: Monitor AI credit usage
  - name: AI Evals
    description: >-
      Manage prompt sets and runs used to score AI quality against curated
      prompt suites.
  - name: AI Model Suggestions
    description: Manage AI-generated suggestions for shared models
  - name: AI Routines
    description: >-
      Manage Routines, which are scheduled, recurring AI-powered tasks that run
      automatically on your data
  - name: Apps
    description: Draft and publish app documents.
  - name: Documents v2
    description: >
      A draft-based workflow for creating and editing documents: create a
      document, patch a draft, then publish.
  - name: Documents
    description: Create, retrieve, and manage documents
  - name: API Tokens
    description: >-
      Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
      grants)
  - name: Connections
    description: Manage database connections
  - name: Connection environments
    description: Manage connection environments database connections
  - name: Color Palettes
    description: Manage custom chart color palettes
  - name: Content
    description: Unified content retrieval (documents and folders)
  - name: Content migration
    description: Export and import dashboards
  - name: Content validator
    description: Validate content against models and perform find/replace operations
  - name: Dashboard downloads
    description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
  - name: Dashboard filters and controls
    description: Read and update dashboard filter and control default values
  - name: dbt
    description: Manage dbt configuration for connections
  - name: Document favorites
    description: Favorite and unfavorite documents
  - name: Document labels
    description: Apply and manage labels on documents
  - name: Document permissions
    description: Manage document-level access
  - name: Embed
    description: Manage embed sessions
  - name: Labels
    description: |
      Manage labels in the organization
  - name: Folders
    description: Create and organize content folders
  - name: Folder labels
    description: Apply and manage labels on folders
  - name: Folder permissions
    description: Manage folder-level access
  - name: Jobs
    description: Check status of asynchronous jobs
  - name: Models
    description: Create and manage data models
  - name: Model branches
    description: Manage model branches and merge changes
  - name: Model git configuration
    description: Manage git configuration for shared models
  - name: Queries
    description: Execute workbook queries
  - name: Schedules
    description: Create and manage scheduled tasks
  - name: Schedule recipients
    description: Manage schedule recipients
  - name: Schema refresh schedules
    description: Manage automated schema refresh schedules for connections
  - name: Skills
    description: >-
      Manage skills, the saved slash-command instructions the Omni AI assistant
      runs
  - name: Topics
    description: Retrieve topic information from models
  - name: Uploads
    description: Manage file uploads
  - name: Users
    description: Manage users
  - name: User attributes
    description: Manage user attribute definitions
  - name: User groups
    description: Manage user groups
  - name: User model roles
    description: Manage model and connection role assignments for users
  - name: User group model roles
    description: Manage model and connection role assignments for user groups
  - name: Uploads
    description: Manage CSV and spreadsheet uploads
paths:
  /v1/users/email-only/bulk:
    delete:
      tags:
        - Schedule recipients
      summary: Bulk delete email-only users
      description: >
        Delete up to 100 [email-only users](/administration/users/email-only) in
        a single request, identified by ID, by email, or a mix of both. Deleting
        an email-only user also removes them as a recipient from every schedule
        they receive.


        If a request includes unknown or previously-deleted users, these users
        will be reported as `notFound` without blocking the rest of the
        request. 


        Use the [Delete users](/api/users/delete-user) endpoint to delete
        standard users and [Delete embed users](/api/users/delete-embed-user) to
        delete embed users.
      operationId: usersDeleteEmailOnlyBulk
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                emails:
                  type: array
                  items:
                    type: string
                    format: email
                  description: Email addresses of the email-only users to delete
                  example:
                    - user@example.com
                userIds:
                  type: array
                  items:
                    type: string
                    format: uuid
                  description: >-
                    IDs of the email-only users to delete. Use the [List
                    email-only users](/api/users/list-email-only-users) endpoint
                    to retrieve IDs.
                  example:
                    - 9e8719d9-276a-4964-9395-a493e1ba5f64
              additionalProperties: false
              anyOf:
                - properties:
                    emails:
                      minItems: 1
                  required:
                    - emails
                - properties:
                    userIds:
                      minItems: 1
                  required:
                    - userIds
            examples:
              byId:
                summary: Delete by ID
                value:
                  userIds:
                    - 9e8719d9-276a-4964-9395-a493e1ba5f64
              byEmail:
                summary: Delete by email
                value:
                  emails:
                    - user@example.com
              mixed:
                summary: Delete by a mix of IDs and emails
                value:
                  userIds:
                    - 9e8719d9-276a-4964-9395-a493e1ba5f64
                  emails:
                    - user@example.com
      responses:
        '200':
          description: >
            The email-only users that were deleted, and any identifiers that
            didn't match an email-only user in your organization.
          content:
            application/json:
              schema:
                type: object
                required:
                  - deleted
                  - notFound
                properties:
                  deleted:
                    type: array
                    description: The email-only users that were deleted
                    items:
                      type: object
                      required:
                        - email
                        - userId
                      properties:
                        email:
                          type: string
                          format: email
                          description: Email address of the user
                          example: user@example.com
                        userId:
                          type: string
                          description: ID of the user
                  notFound:
                    type: object
                    required:
                      - emails
                      - userIds
                    description: >-
                      Requested identifiers that didn't match an email-only user
                      in the organization
                    properties:
                      emails:
                        type: array
                        items:
                          type: string
                        description: >-
                          Requested emails that do not belong to an email-only
                          user
                      userIds:
                        type: array
                        items:
                          type: string
                        description: Requested IDs that do not belong to an email-only user
              example:
                deleted:
                  - email: user@example.com
                    userId: 9e8719d9-276a-4964-9395-a493e1ba5f64
                notFound:
                  emails:
                    - unknown@example.com
                  userIds: []
        '400':
          description: >
            Bad Request. Possible error messages include:


            - `Invalid JSON`

            - Must provide at least one of `emails` or `userIds`

            - `emails: Invalid email address`

            - `userIds: Invalid uuid`

            - Maximum of 100 combined emails and user IDs can be processed in a
            single request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError400'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError401'
        '403':
          description: >
            Forbidden - insufficient permissions. Organization API keys are
            always allowed. [Personal Access Tokens
            (PAT)](/api/authentication#token-types) must have permissions to
            manage users, typically **Organization Admin**.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError403'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - bearerAuth: []
components:
  schemas:
    ApiError400:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 400
      required:
        - detail
        - status
    ApiError401:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
          example: 'Unauthorized: Missing or invalid API key'
        status:
          type: integer
          description: HTTP status code of the error.
          example: 401
      required:
        - detail
        - status
    ApiError403:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message describing what went wrong.
        status:
          type: integer
          description: HTTP status code of the error.
          example: 403
      required:
        - detail
        - status
    Error:
      type: object
      properties:
        error:
          type: string
          description: HTTP response code for the error
          example: <response_code>
        message:
          type: string
          description: Detailed error description
          example: <error_reason>
  responses:
    MethodNotAllowed:
      description: Method Not Allowed - Invalid HTTP method for this endpoint
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Too Many Requests - Rate limit exceeded (60 requests/minute)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Can be either an [Organization API
        Key](/api/authentication#organization-api-keys) or [Personal Access
        Token (PAT)](/api/authentication#token-types).


        Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
    orgApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Requires an [Organization API
        Key](/api/authentication#organization-api-keys). Personal Access Tokens
        (PATs) are not supported for this endpoint.


        Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`

````