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

# Rename table or list



## OpenAPI

````yaml /en/openapi.json patch /v1/tables/{id}
openapi: 3.0.0
info:
  title: Nuvia API - Company
  description: API documentation for companies
  version: '1.0'
  contact: {}
servers:
  - url: https://api.nuvia.ai
security: []
tags:
  - name: messages
    x-group: Mensagens
  - name: contacts
    x-group: Contatos
  - name: campaigns
    x-group: Campanhas
  - name: tables
    x-group: Tabelas e Listas
  - name: agents
    x-group: Agentes
  - name: conversations
    x-group: Conversas
  - name: inboxes
    x-group: Caixas de Entrada
  - name: knowledge
    x-group: Base de Conhecimento
  - name: Webhooks
    x-group: Webhooks
  - name: campaign-enrollments
    x-group: Inscrições em Campanha
  - name: custom-fields
    x-group: Campos Customizados
  - name: resources
    x-group: Arquivos e Anexos
  - name: hubspot
    x-group: HubSpot
paths:
  /v1/tables/{id}:
    patch:
      tags:
        - tables
      summary: Rename table or list
      operationId: TableController_update
      parameters:
        - name: x-company-id
          in: header
          description: >-
            Target company identifier. Required only for global API keys
            (type=global). Ignored for company API keys and human users.
          required: false
          schema:
            type: string
        - name: id
          required: true
          in: path
          description: Table ID
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTableDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableEntity'
      security:
        - JWT-auth: []
components:
  schemas:
    UpdateTableDto:
      type: object
      properties:
        name:
          type: string
          maxLength: 100
          description: Table name
        description:
          type: string
          description: Table description
      required:
        - name
    TableEntity:
      type: object
      properties:
        _id:
          $ref: '#/components/schemas/ObjectId'
        name:
          type: string
        description:
          type: string
        file_url:
          type: string
        status:
          enum:
            - PROCESSING
            - READY
            - ERROR
            - PARTIAL
          type: string
        type:
          enum:
            - DEFAULT
            - FILE
          type: string
        table_kind:
          enum:
            - dataset
            - list
          type: string
        object_type:
          enum:
            - contact
            - business
          type: string
        file_metadata:
          type: object
        columns:
          type: array
          items:
            type: object
        stats:
          type: object
        import_errors:
          type: array
          items:
            type: object
        summary:
          type: string
        data:
          deprecated: true
          type: array
          items:
            type: object
        sync_key_column:
          type: string
          description: >-
            Key of the business column used as the key in the upload sync
            (diff).

            Without it, the upload sync is rejected.
        ranking_config:
          description: |-
            Ordered business ranking criteria. The sync materializes the result
            in the internal _score column (higher = better).
          type: array
          items:
            type: object
        company:
          $ref: '#/components/schemas/CompanyEntity'
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
        - _id
        - name
        - status
        - type
        - table_kind
        - columns
        - stats
        - company
    ObjectId:
      type: object
      properties: {}
    CompanyEntity:
      type: object
      properties:
        _id:
          $ref: '#/components/schemas/ObjectId'
        name:
          type: string
        channels:
          type: array
          items:
            type: string
            enum:
              - WAP_AUTO_CLOSER
              - WEB_V2
              - EVOLUTION_API
              - LINKEDIN
              - EMAIL
              - WEBCHAT
        agent_flows:
          type: array
          items:
            $ref: '#/components/schemas/AgentFlowEntity'
        description:
          type: string
          description: >-
            Free-text description of the company. Optional, up to 300
            characters.
        domains:
          description: >-
            Email domains that resolve to this company at self-service sign-up.
            A domain belongs to at most one company. Stored in lowercase and
            without spaces. Absent when the company did not come from
            self-service.
          type: array
          items:
            type: string
        site:
          type: string
          description: >-
            Website informed at sign-up. Informational only: it does not resolve
            a company by domain and is not unique.
        general_config:
          type: object
        status:
          enum:
            - ACTIVE
            - INACTIVE
            - DELETED
          type: string
        agent_builder_mcp_enabled:
          type: boolean
          description: >-
            Makes the agent builder tools available on this company's `/mcp`.
            Defaults to `true`; `false` turns them off. Authoring stays
            restricted to COMPANY_ADMIN: a regular user can only read and
            simulate.
        client_mcp_servers_enabled:
          type: boolean
          description: >-
            Whether this company can register its own MCP servers as agent
            tools. Defaults to `false`.
        auto_join_enabled:
          type: boolean
          description: >-
            Automatic join by domain. Absent or `false`: signing up with an
            email on this company's domain creates an access request. `true`:
            the person joins directly as a member. This applies to this company
            only; with a domain shared by several companies, the person still
            chooses.
        subscription:
          type: object
          description: Status of the company's subscription or trial. Absent means active.
        document_type:
          description: >-
            Tax document type of the company. The values are Stripe `tax_id`
            codes.
          enum:
            - br_cnpj
            - br_cpf
            - us_ein
            - eu_vat
            - gb_vat
            - other
          type: string
        document_number:
          type: string
          description: >-
            Tax document number, with no formatting characters and in uppercase.
            Required when the company is created with a contracted plan, and
            editable afterwards.
        stripe_customer_id:
          type: string
        billing_external:
          type: boolean
          description: >-
            Administrative billing flag. Does not affect the company's access to
            the platform.
        billing_partner:
          type: boolean
          description: >-
            Administrative flag set when the company is created. It cannot be
            edited afterwards and does not affect the company's access to the
            platform.
        onboarding:
          type: object
          description: State of the onboarding wizard. Absent means complete.
        attribution:
          type: object
          description: >-
            Marketing origin (`utm_*`) recorded when the company was created.
            Absent when there is no origin data.
      required:
        - _id
        - name
        - channels
        - agent_flows
        - description
        - status
    AgentFlowEntity:
      type: object
      properties:
        _id:
          $ref: '#/components/schemas/ObjectId'
        name:
          type: string
        url:
          type: string
        specialist_url:
          type: string
        type:
          enum:
            - N8N
            - API
            - INTERNAL
          type: string
      required:
        - _id
        - name
        - url
        - specialist_url
        - type
  securitySchemes:
    JWT-auth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: JWT authentication token

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.