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

> Create a company, or update it if the external_id already exists. Attributes merge into the existing record.

# Create or update a company



## OpenAPI

````yaml post /companies
openapi: 3.1.0
info:
  title: OpenCX API
  description: >

    OpenCX is an AI-powered, all-in-one platform for customer support and
    outbound communications.


    Use this API to manage your OpenCX organization's AI agents, actions,
    conversations, contacts, and more.


    To get started, generate a new API key from the dashboard.


    ## Authentication

    All API endpoints require authentication using a Bearer token. You can
    generate an API key from your OpenCX dashboard.


    ## Rate Limiting

    API requests are rate limited to ensure fair usage. The current limits are:

    - 100 requests per minute for standard endpoints

    - 1000 requests per minute for streaming endpoints


    ## Error Handling

    The API uses standard HTTP status codes and returns detailed error messages
    in the response body.
  version: 1.0-beta
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: http://localhost:8080
    description: Development
  - url: https://api.open.cx
    description: Production
security:
  - bearerAuth: []
paths:
  /companies:
    post:
      summary: Create or update a company
      description: >-
        Upsert a company by the organization's own key (`external_id`). Creates
        it when unknown, otherwise merges into the existing record. `name` is
        required only when creating. Attributes merge — send an attribute as
        null to clear it.
      operationId: upsertCompany
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertCompanyDto'
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
components:
  schemas:
    UpsertCompanyDto:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/UpsertCompanyDtoInput'
      type: object
      properties:
        external_id:
          type: string
          minLength: 1
        name:
          type: string
          minLength: 1
        custom_data:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            anyOf:
              - type: string
              - type: number
              - type: boolean
              - type: 'null'
      required:
        - external_id
    Company:
      $schema: https://json-schema.org/draft/2020-12/schema
      $id: '#/components/schemas/Company'
      type: object
      properties:
        id:
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        external_id:
          type: string
          description: The organization's own key for this company
        name:
          type: string
        custom_data:
          anyOf:
            - type: object
              propertyNames:
                type: string
              additionalProperties:
                anyOf:
                  - type: string
                  - type: number
                  - type: boolean
            - type: 'null'
        created_at:
          type: string
          description: ISO 8601 timestamp of when the company was created
        updated_at:
          type: string
          description: ISO 8601 timestamp of when the company was last updated
      required:
        - id
        - external_id
        - name
        - custom_data
        - created_at
        - updated_at
      additionalProperties: false
    ErrorDto:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````