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

# Bulk import leads

> Imports up to 2000 leads in a single transaction. `mode='merge'` (default) timestamp-appends notes and DISTINCT-unions tags on existing rows; `mode='skip'` leaves existing rows untouched.
Requires scope: `leads:write`.




## OpenAPI

````yaml /api-reference/openapi.json post /v1/leads/bulk
openapi: 3.0.3
info:
  title: TopCalls Voice API
  description: >
    TopCalls Voice Gateway API for creating and managing AI-powered phone calls.


    ## Authentication


    All API requests require authentication. Include your API key in the
    `Authorization` header:


    ```

    Authorization: Bearer tc_live_xxxxx

    ```


    ## Rate Limits


    Direct call creation via `POST /v1/calls` is limited to your account's

    `max_calls_per_minute` setting (default: 20) per minute. Exceeding it
    returns

    `429 Too Many Requests` with a `Retry-After` header.

    All endpoints are additionally subject to a flat limit of 120 requests per

    minute per account (all methods).


    On a `429`, wait for the number of seconds in the `Retry-After` header, then

    retry the same request. For automated clients, back off progressively on

    repeated `429`s. Limits are per account and are shared by all API keys.


    ## Error Format


    All errors follow RFC 7807 Problem+JSON format:


    ```json

    {
      "type": "https://api.topcalls.ai/errors/insufficient_quota",
      "title": "Insufficient Quota",
      "status": 402,
      "detail": "Not enough remaining call minutes to admit this call"
    }

    ```
  version: 1.0.0
  contact:
    name: TopCalls Support
    url: https://topcalls.ai
  license:
    name: Proprietary
servers:
  - url: https://api.topcalls.ai
    description: Production
security: []
tags:
  - name: Calls
    description: Create and manage phone calls
  - name: Phone Numbers
    description: Manage phone numbers and carriers
  - name: Account
    description: Account information and usage
  - name: Webhooks
    description: Webhook configuration and events
  - name: Configuration
    description: Available AI models, voices, and platform capabilities
paths:
  /v1/leads/bulk:
    post:
      summary: Bulk import leads
      description: >
        Imports up to 2000 leads in a single transaction. `mode='merge'`
        (default) timestamp-appends notes and DISTINCT-unions tags on existing
        rows; `mode='skip'` leaves existing rows untouched.

        Requires scope: `leads:write`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - list_id
                - leads
              properties:
                list_id:
                  type: string
                  format: uuid
                mode:
                  type: string
                  enum:
                    - skip
                    - merge
                  default: merge
                leads:
                  type: array
                  minItems: 1
                  maxItems: 2000
                  items:
                    $ref: '#/components/schemas/LeadBulkRow'
      responses:
        '200':
          description: Bulk result
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - inserted
                  - updated
                  - duplicates
                  - total_processed
                  - duration_ms
                properties:
                  success:
                    type: boolean
                  inserted:
                    type: integer
                  updated:
                    type: integer
                  duplicates:
                    type: integer
                  total_processed:
                    type: integer
                  duration_ms:
                    type: integer
        '400':
          description: Invalid input
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: Rate limit exceeded
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '500':
          description: Internal error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - bearerAuth: []
components:
  schemas:
    LeadBulkRow:
      type: object
      additionalProperties: false
      required:
        - phone_number
      properties:
        name:
          type: string
          default: ''
        phone_number:
          type: string
          pattern: ^\+[1-9]\d{8,14}$
          description: >-
            Phone number in E.164 format (also validated as dialable; country
            codes that don't exist are rejected)
        email:
          type: string
          format: email
          nullable: true
        status:
          type: string
          enum:
            - New
            - Contacted
            - Converted
            - Unsubscribed
        notes:
          type: string
          nullable: true
        tags:
          type: array
          items:
            type: string
          default: []
        metadata:
          type: object
          additionalProperties: true
    Problem:
      type: object
      required:
        - status
        - title
      properties:
        type:
          type: string
          format: uri
          description: Error type URI
        title:
          type: string
          description: Error title
        status:
          type: integer
          description: HTTP status code
        detail:
          type: string
          description: Human-readable error detail
        code:
          type: string
          description: >
            Machine-readable error code for programmatic handling. Present on

            errors that carry a stable identifier (e.g. `PROMPT_SAFETY_FRAUD`,

            `job_not_found`, `too_many_ids`, `no_matches`). Distinct from the

            per-field `errors[].code` used for validation failures. Scenario-

            specific — see each endpoint's response examples for the exact
            value.
        instance:
          type: string
          format: uuid
          description: Request instance ID
        errors:
          type: array
          description: Validation errors (for 400 responses)
          items:
            type: object
            properties:
              path:
                type: string
                description: Field path (e.g., "phone_number", "metadata.from_number")
              message:
                type: string
                description: Error message
              code:
                type: string
                description: Error code (e.g., "invalid_string", "custom")
        details:
          type: string
          description: Additional error details (for provider errors)
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Use `Authorization: Bearer tc_live_xxxxx`

````