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

# Bulk action on leads

> Perform a bulk action (assign, change status, delete) on multiple leads at once.



## OpenAPI

````yaml /api-reference/voxys_crm_swagger.json post /api/v1/accounts/{account_id}/leads/bulk
openapi: 3.1.0
info:
  title: Voxys Connect - CRM APIs
  description: >-
    CRM API documentation for Voxys Connect, covering Leads, Companies,
    Pipelines, Follow-up Tasks, and Conversation CRM.
  version: 1.0.0
  contact:
    email: support@voxys.ai
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://connect.voxys.ai
security:
  - userApiKey: []
tags:
  - name: Leads
    description: >-
      Manage CRM leads including creation, status changes, notes, and
      conversion.
  - name: Companies
    description: Manage companies, their contacts, timelines, and duplicate merging.
  - name: Pipelines
    description: Manage sales funnels (pipelines), their stages, and kanban cards.
  - name: Follow-up Tasks
    description: >-
      Create and manage follow-up tasks attached to leads, deals, or
      conversations.
  - name: Conversation CRM
    description: >-
      CRM panel within a conversation: link pipelines, leads, and convert to
      deal.
paths:
  /api/v1/accounts/{account_id}/leads/bulk:
    parameters:
      - $ref: '#/components/parameters/account_id'
    post:
      tags:
        - Leads
      summary: Bulk action on leads
      description: >-
        Perform a bulk action (assign, change status, delete) on multiple leads
        at once.
      operationId: bulk-action-leads
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/lead_bulk_payload'
      responses:
        '200':
          description: Bulk action completed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  affected_count:
                    type: integer
                    example: 3
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validation_error'
components:
  parameters:
    account_id:
      name: account_id
      in: path
      required: true
      schema:
        type: integer
      description: The numeric ID of the account.
  schemas:
    lead_bulk_payload:
      type: object
      required:
        - lead_ids
        - action_type
      properties:
        lead_ids:
          type: array
          items:
            type: integer
          example:
            - 1
            - 2
            - 3
        action_type:
          type: string
          enum:
            - assign
            - status_change
            - delete
          example: assign
        params:
          type: object
          description: >-
            Additional params depending on action_type, e.g.
            {"assigned_agent_id": 5} or {"status": "won"}
          additionalProperties: true
          example:
            assigned_agent_id: 5
    error_response:
      type: object
      properties:
        error:
          type: string
          example: Unauthorized
    validation_error:
      type: object
      properties:
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          example:
            name:
              - can't be blank
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: >-
        API access token for authentication. Obtain from your Voxys Connect
        profile settings.

````