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

# Create a customer

> Registers one of your end-customers as a sub-tenant so they can connect their own tool accounts. See [B2B2B customers](/b2b2b-customers) for the full flow.

`external_id` is your identifier and must be unique on your account — re-creating with the same one is how you find a customer again without storing our ID.



## OpenAPI

````yaml /openapi.json post /customers
openapi: 3.1.0
info:
  title: Vocobase API
  version: '2.0'
  description: >-
    API for managing voice AI agents, documents, and calls on the Vocobase
    platform.
servers:
  - url: https://api.vocobase.com/api/v2
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Config
    description: >-
      Read and update account configuration, webhook settings, and telephony
      credentials.
  - name: Agents
    description: Create, read, update, and delete voice AI agents.
  - name: Voices
    description: >-
      List voice tiers, available voices, and stream preview audio for agent
      configuration.
  - name: Documents
    description: Upload, manage, and delete knowledge base documents.
  - name: Agent Documents
    description: Link and unlink documents to agents for knowledge base integration.
  - name: Calls
    description: Initiate outbound calls and view call history.
  - name: Phone Numbers
    description: >-
      Import DIDs, assign agents for inbound routing, and re-sync carrier
      Application bindings.
  - name: Inbound Routing Policies
    description: >-
      Define pre-answer routing decisions for inbound calls before AI sessions
      are created.
  - name: Telephony Connections
    description: Create, list, rename, and disconnect named V2 telephony connections.
  - name: VoiceLink Management
    description: Manage VoiceLink reseller clients, DID mapping, and readiness sync.
  - name: Projects
    description: Organize agents into projects. Every agent belongs to exactly one project.
  - name: Dictionaries
    description: Speech-recognition dictionary CRUD and agent attachment.
  - name: Sessions
    description: Browser-initiated WebRTC voice sessions for in-app voice agents.
  - name: Campaigns
    description: Batch outbound calling.
  - name: Billing
    description: Balance, transactions, and usage summaries.
  - name: Custom Functions
    description: HTTP endpoints the agent can call mid-conversation.
  - name: Extraction Sets
    description: Reusable sets of post-call extraction fields.
  - name: Lifecycle Hooks
    description: Automatic pre-call and post-call integration steps.
  - name: Messaging
    description: Bring-your-own WhatsApp sending.
  - name: Integration Logs
    description: Audit trail for integration calls.
  - name: Connectors
    description: Catalog of tools an agent can be connected to.
  - name: Customers
    description: B2B2B sub-tenants and their tool connections.
  - name: Agent Tools
    description: Binding connectors and connections to an agent.
paths:
  /customers:
    post:
      tags:
        - Customers
      summary: Create a customer
      description: >-
        Registers one of your end-customers as a sub-tenant so they can connect
        their own tool accounts. See [B2B2B customers](/b2b2b-customers) for the
        full flow.


        `external_id` is your identifier and must be unique on your account —
        re-creating with the same one is how you find a customer again without
        storing our ID.
      operationId: createCustomer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - external_id
                - name
              properties:
                external_id:
                  type: string
                  minLength: 1
                  maxLength: 200
                name:
                  type: string
                  minLength: 1
                  maxLength: 200
                email:
                  type: string
                  maxLength: 254
                  nullable: true
                metadata:
                  type: object
                  nullable: true
                  additionalProperties: true
            example:
              external_id: acct_10231
              name: Northwind Traders
              email: ops@northwind.example
              metadata:
                plan: enterprise
      responses:
        '200':
          description: Customer created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    $ref: '#/components/schemas/PartnerCustomer'
              example:
                success: true
                data:
                  id: pc_92a3b4c5-d6e7-f809-1223-344556677889
                  external_id: acct_10231
                  name: Northwind Traders
                  email: ops@northwind.example
                  metadata:
                    plan: enterprise
                  status: ACTIVE
                  created_at: '2026-08-10T09:00:00.000Z'
                  updated_at: '2026-08-10T09:00:00.000Z'
        '400':
          description: '`INVALID_EXTERNAL_ID`, `INVALID_NAME`, or `INVALID_EMAIL`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error:
                  code: INVALID_EXTERNAL_ID
                  message: external_id is required, 1..200 chars
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    PartnerCustomer:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Vocobase ID for the customer.
        external_id:
          type: string
          description: Your own ID for this customer. Unique on your account.
        name:
          type: string
        email:
          type: string
          nullable: true
        metadata:
          type: object
          nullable: true
          additionalProperties: true
        status:
          type: string
          enum:
            - ACTIVE
            - ARCHIVED
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - success
        - error
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: UNAUTHORIZED
              message: Invalid or missing API key
    RateLimitExceeded:
      description: Per-account rate limit exceeded. Retry after a short backoff.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: RATE_LIMITED
              message: Rate limit exceeded. Retry after 60 seconds.
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: INTERNAL_ERROR
              message: An unexpected error occurred
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key in format: `rg_live_xxxx`. Pass as a Bearer token in the
        Authorization header.

````