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

# Bulk Create Contacts

> Bulk create contacts (max 1000 per request).

Optionally skip duplicates based on phone, email, or whatsapp_number.



## OpenAPI

````yaml /openapi.json post /contacts/bulk
openapi: 3.1.0
info:
  title: Kejue Public API
  description: >-
    The Kejue Public API lets you programmatically create calls, manage
    campaigns, and retrieve call results.


    ## Authentication


    All requests require an API key passed in the `X-API-Key` header:


    ```

    X-API-Key: kej_live_...

    ```


    API keys are scoped to a workspace. Create and manage keys from the Kejue
    dashboard under **Settings → API Keys**.


    ## Base URL


    ```

    https://api.kejue.co/api/v1

    ```


    ## Rate Limits


    API requests are rate-limited per workspace. If you exceed the limit you'll
    receive a `429 Too Many Requests` response.


    ## Errors


    All error responses follow a consistent format:


    ```json

    {
      "error": "Human-readable message",
      "code": "ERROR_CODE",
      "details": {}
    }

    ```
  version: 1.0.0
servers:
  - url: https://api.kejue.co/api/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Agents
    description: >-
      Create and manage AI agents (personas). Each agent has a name, prompt,
      voice configuration, and optional tools. Agents are the core building
      block — attach voice configs, tools, and use them to make calls.
  - name: Calls
    description: >-
      Create outbound calls, retrieve call details and transcripts, and list
      calls with filtering. Each call is associated with a contact and
      optionally an agent and campaign.
  - name: Persona Calls
    description: >-
      Create calls with the full agent configuration pre-loaded. Applies the
      complete settings hierarchy (workspace → agent → campaign → overrides)
      with all agent tools, tags, scoring, and webhooks inherited automatically.
  - name: Contacts
    description: >-
      Create and manage contacts. Contacts represent the people your agents
      call. Each contact has a phone number, name, and optional metadata.
      Supports single creation, bulk import, and CSV upload.
  - name: Campaigns
    description: >-
      Create and manage calling campaigns. Campaigns let you batch-call a list
      of contacts with shared settings, scheduling, and retry logic.
  - name: Tools
    description: >-
      Create and manage custom HTTP tools that agents can invoke during calls.
      Tools let agents fetch data, trigger actions, or integrate with external
      systems mid-conversation.


      Each tool supports three parameter types:

      - **Dynamic parameters** — filled by the AI at runtime (visible to the AI)

      - **Static parameters** — fixed values sent with every invocation (hidden
      from the AI)

      - **System parameters** — values injected from the execution context at
      runtime, such as `call_id`, `contact_id`, or `workspace_id` (hidden from
      the AI)
  - name: Voices
    description: List available voices for use in agent voice configurations.
  - name: Phone Numbers
    description: List phone numbers available in your workspace for making outbound calls.
  - name: Webhooks
    description: >-
      Create and manage webhook subscriptions. Receive real-time notifications
      for call events (started, ended, etc.) at your specified URL.
  - name: Models
    description: List available AI models for use in agent voice configurations.
paths:
  /contacts/bulk:
    post:
      tags:
        - Contacts
      summary: Bulk Create Contacts
      description: |-
        Bulk create contacts (max 1000 per request).

        Optionally skip duplicates based on phone, email, or whatsapp_number.
      operationId: bulk_create_contacts_contacts_bulk_post
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkCreateContacts'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkCreateContactsResponse'
        '401':
          description: >-
            Missing or invalid API key. Pass a workspace API key in the
            `X-API-Key` header.
          content:
            application/json:
              example:
                error: Invalid or missing API key
                code: UNAUTHORIZED
                details: {}
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Request body or query parameters failed validation.
          content:
            application/json:
              example:
                error: Validation failed
                code: VALIDATION_ERROR
                details:
                  errors:
                    - field: body.name
                      message: Field required
                      type: missing
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    BulkCreateContacts:
      properties:
        contacts:
          items:
            $ref: '#/components/schemas/CreateContact'
          type: array
          maxItems: 1000
          title: Contacts
          description: Contacts to create (max 1000)
        skip_duplicates:
          type: boolean
          title: Skip Duplicates
          description: Skip contacts with duplicate phone numbers
          default: true
        duplicate_field:
          $ref: '#/components/schemas/DuplicateField'
          description: Field to check for duplicates
          default: phone
      type: object
      required:
        - contacts
      title: BulkCreateContacts
      description: Bulk create contacts.
    BulkCreateContactsResponse:
      properties:
        created:
          type: integer
          title: Created
          description: Number of contacts successfully created
        skipped:
          type: integer
          title: Skipped
          description: Number of contacts skipped (duplicates)
        errors:
          items:
            $ref: '#/components/schemas/BulkImportError'
          type: array
          title: Errors
          description: Errors for contacts that failed
      type: object
      required:
        - created
        - skipped
      title: BulkCreateContactsResponse
      description: Bulk create result.
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
        code:
          type: string
          title: Code
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
      type: object
      required:
        - error
        - code
      title: ErrorResponse
      description: Standard error response.
      example:
        code: NOT_FOUND
        details:
          contact_id: '123'
        error: Contact not found
    CreateContact:
      properties:
        phone:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone
          description: Phone number (E.164 recommended)
        whatsapp_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Whatsapp Number
          description: WhatsApp number (E.164)
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
          description: Email address
        first_name:
          anyOf:
            - type: string
            - type: 'null'
          title: First Name
          description: First name
        last_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Name
          description: Last name
        company:
          anyOf:
            - type: string
            - type: 'null'
          title: Company
          description: Company name
        job_title:
          anyOf:
            - type: string
            - type: 'null'
          title: Job Title
          description: Job title
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
          description: ISO country code
        timezone:
          anyOf:
            - type: string
            - type: 'null'
          title: Timezone
          description: IANA timezone
        language:
          anyOf:
            - type: string
            - type: 'null'
          title: Language
          description: Language code
        tags:
          items:
            type: string
          type: array
          title: Tags
          description: Tags
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
          description: Custom key-value metadata
      type: object
      title: CreateContact
      description: Create a contact. All fields optional.
    DuplicateField:
      type: string
      enum:
        - phone
        - email
        - whatsapp_number
      title: DuplicateField
      description: Field to check for duplicates during bulk contact import.
    BulkImportError:
      properties:
        index:
          type: integer
          title: Index
          description: Zero-based index of the contact in the request array
        error:
          type: string
          title: Error
          description: Error message
      type: object
      required:
        - index
        - error
      title: BulkImportError
      description: An error that occurred during bulk import.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Workspace API key (e.g. `kej_live_...`)

````