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

# Update an existing table

> Atualize uma tabela HubDB existente. Você pode usar este ponto de extremidade para adicionar ou remover colunas da tabela, bem como restaurar uma tabela arquivada. As tabelas atualizadas usando o ponto de extremidade modificarão apenas a versão de rascunho da tabela. Use o ponto de extremidade "/publish" para aplicar todas as alterações à versão publicada. Para restaurar uma tabela, inclua o parâmetro de consulta "archived=true" e "archived: false" no corpo do json.
**Observação:** você precisa incluir todas as colunas na entrada ao adicionar/remover/atualizar uma coluna. Se você não incluir uma coluna já existente na solicitação, ela será excluída.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2026-03/cms-hubdb-v2026-03.json PATCH /cms/hubdb/2026-03/tables/{tableIdOrName}/draft
openapi: 3.0.1
info:
  title: HubDB
  description: Basepom for all HubSpot Projects
  version: 2026-03
  x-hubspot-product-tier-requirements:
    marketing: PROFESSIONAL
    sales: FREE
    service: FREE
    cms: PROFESSIONAL
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Linhas
  - name: Rows
  - name: Tabelas
  - name: Tables
paths:
  /cms/hubdb/2026-03/tables/{tableIdOrName}/draft:
    patch:
      tags:
        - Tabelas
        - Tables
      summary: Atualizar uma tabela existente
      description: >-
        Atualize uma tabela HubDB existente. Você pode usar este ponto de
        extremidade para adicionar ou remover colunas da tabela, bem como
        restaurar uma tabela arquivada. As tabelas atualizadas usando o ponto de
        extremidade modificarão apenas a versão de rascunho da tabela. Use o
        ponto de extremidade "/publish" para aplicar todas as alterações à
        versão publicada. Para restaurar uma tabela, inclua o parâmetro de
        consulta "archived=true" e "archived: false" no corpo do json.

        **Observação:** você precisa incluir todas as colunas na entrada ao
        adicionar/remover/atualizar uma coluna. Se você não incluir uma coluna
        já existente na solicitação, ela será excluída.
      operationId: patch-/cms/hubdb/2026-03/tables/{tableIdOrName}/draft_updateDraftTable
      parameters:
        - name: tableIdOrName
          in: path
          description: O identificador exclusivo ou nome da tabela a ser atualizada.
          required: true
          style: simple
          explode: false
          schema:
            type: string
        - name: archived
          in: query
          description: Se apenas os resultados que foram arquivados devem ser retornados.
          required: false
          style: form
          explode: true
          schema:
            type: boolean
        - name: includeForeignIds
          in: query
          description: Incluir IDs estrangeiros na resposta.
          required: false
          style: form
          explode: true
          schema:
            type: boolean
        - name: isGetLocalizedSchema
          in: query
          description: Se o esquema localizado deve ser recuperado.
          required: false
          style: form
          explode: true
          schema:
            type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HubDbTableV3Request'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubDbTableV3'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - hubdb.tables.write
components:
  schemas:
    HubDbTableV3Request:
      required:
        - allowChildTables
        - allowPublicApiAccess
        - columns
        - dynamicMetaTags
        - enableChildTablePages
        - label
        - name
        - useForPages
      type: object
      properties:
        allowChildTables:
          type: boolean
          description: Especifica se as tabelas secundárias podem ser criadas
        allowPublicApiAccess:
          type: boolean
          description: Especifica se a tabela pode ser lida pelo público sem autorização
        columns:
          type: array
          description: Lista de colunas na tabela
          items:
            $ref: '#/components/schemas/ColumnRequest'
        dynamicMetaTags:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: >-
            Especifica os pares de valores-chave dos [campos de
            metadados](https://developers.hubspot.com/docs/cms/guides/dynamic-pages/hubdb#dynamic-pages)
            com os IDs de coluna associados.
        enableChildTablePages:
          type: boolean
          description: >-
            Especifica a criação de páginas dinâmicas de vários níveis usando
            tabelas secundárias
        label:
          type: string
          description: Rótulo da tabela
        name:
          type: string
          description: Nome da tabela
        useForPages:
          type: boolean
          description: >-
            Especifica se a tabela pode ser usada para criação de páginas
            dinâmicas
    HubDbTableV3:
      required:
        - allowChildTables
        - allowPublicApiAccess
        - columnCount
        - columns
        - createdAt
        - deleted
        - deletedAt
        - dynamicMetaTags
        - enableChildTablePages
        - id
        - label
        - name
        - published
        - publishedAt
        - rowCount
        - updatedAt
        - useForPages
      type: object
      properties:
        allowChildTables:
          type: boolean
          description: Especifica se as tabelas secundárias podem ser criadas
        allowPublicApiAccess:
          type: boolean
          description: Especifica se a tabela pode ser lida pelo público sem autorização
        columnCount:
          type: integer
          description: Número de colunas, incluindo as excluídas
          format: int64
        columns:
          type: array
          description: Lista de colunas na tabela
          items:
            $ref: '#/components/schemas/Column'
        createdAt:
          type: string
          description: A data e hora em que a tabela foi criada
          format: date-time
        createdBy:
          $ref: '#/components/schemas/SimpleUser'
        deleted:
          type: boolean
          description: Especifica se a tabela está marcada como excluída.
        deletedAt:
          type: string
          description: A data e a hora que indica quando a tabela foi excluída.
          format: date-time
        dynamicMetaTags:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: >-
            Especifica os pares de valores-chave dos [campos de
            metadados](https://developers.hubspot.com/docs/cms/guides/dynamic-pages/hubdb#dynamic-pages)
            com os IDs de coluna associados.
        enableChildTablePages:
          type: boolean
          description: >-
            Especifica a criação de páginas dinâmicas de vários níveis usando
            tabelas secundárias
        id:
          type: string
          description: ID da tabela
        isOrderedManually:
          type: boolean
          description: Indica se as linhas da tabela estão ordenadas manualmente.
        label:
          type: string
          description: Rótulo da tabela
        name:
          type: string
          description: Nome da tabela
        published:
          type: boolean
          description: Indica se a tabela está atualmente publicada.
        publishedAt:
          type: string
          description: A data e hora em que a tabela foi publicada recentemente
          format: date-time
        rowCount:
          type: integer
          description: Número de linhas na tabela
          format: int32
        updatedAt:
          type: string
          description: A data e hora em que a tabela foi atualizada recentemente
          format: date-time
        updatedBy:
          $ref: '#/components/schemas/SimpleUser'
        useForPages:
          type: boolean
          description: >-
            Especifica se a tabela pode ser usada para criação de páginas
            dinâmicas
    ColumnRequest:
      required:
        - id
        - label
        - name
        - options
        - type
      type: object
      properties:
        foreignColumnId:
          type: integer
          description: O ID da coluna de outra tabela à qual a coluna se refere/aponta.
          format: int32
        foreignTableId:
          type: integer
          description: O ID da outra tabela à qual a coluna se refere/aponta.
          format: int64
        id:
          type: integer
          description: ID da coluna
          format: int32
        label:
          type: string
          description: Rótulo da coluna
        maxNumberOfCharacters:
          type: integer
          description: Define o número máximo de caracteres permitidos na coluna.
          format: int32
        maxNumberOfOptions:
          type: integer
          description: >-
            Especifica o número máximo de opções que podem ser definidas para
            colunas de seleção e de seleção múltipla.
          format: int32
        name:
          type: string
          description: Nome da coluna
        options:
          type: array
          description: Opções para escolher para colunas de seleção única e múltipla
          items:
            $ref: '#/components/schemas/Option'
        type:
          type: string
          description: Tipo de coluna
          enum:
            - BOOLEAN
            - CODE
            - COMPOSITE
            - CTA
            - CURRENCY
            - DATE
            - DATETIME
            - EMBED
            - FILE
            - FOREIGN_ID
            - HUBSPOT_VIDEO
            - IMAGE
            - JSON
            - LOCATION
            - MULTISELECT
            - 'NULL'
            - NUMBER
            - RICHTEXT
            - SELECT
            - TEXT
            - URL
            - VIDEO
    Column:
      required:
        - deleted
        - description
        - id
        - label
        - name
        - type
      type: object
      properties:
        createdAt:
          type: string
          description: A data e a hora em que a coluna foi criada.
          format: date-time
        createdBy:
          $ref: '#/components/schemas/SimpleUser'
        createdByUserId:
          type: integer
          description: O ID do usuário que criou a coluna.
          format: int32
        deleted:
          type: boolean
          description: Indica se a coluna foi excluída.
        description:
          type: string
          description: A descrição da coluna.
        foreignColumnId:
          type: integer
          description: ID de coluna externo
          format: int32
        foreignIds:
          type: array
          description: IDs externos
          items:
            $ref: '#/components/schemas/ForeignId'
        foreignIdsById:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ForeignId'
          description: IDs externos
        foreignIdsByName:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ForeignId'
          description: IDs externos por nome
        foreignTableId:
          type: integer
          description: ID externo da tabela referenciado
          format: int64
        id:
          type: string
          description: ID da coluna
        label:
          type: string
          description: Rótulo da coluna
        name:
          type: string
          description: Nome da coluna
        optionCount:
          type: integer
          description: Número de opções disponíveis
          format: int32
        options:
          type: array
          description: Opções para escolher para colunas de seleção única e múltipla
          items:
            $ref: '#/components/schemas/Option'
        type:
          type: string
          description: Tipo de coluna
          enum:
            - BOOLEAN
            - CODE
            - COMPOSITE
            - CTA
            - CURRENCY
            - DATE
            - DATETIME
            - EMBED
            - FILE
            - FOREIGN_ID
            - HUBSPOT_VIDEO
            - IMAGE
            - JSON
            - LOCATION
            - MULTISELECT
            - 'NULL'
            - NUMBER
            - RICHTEXT
            - SELECT
            - TEXT
            - URL
            - VIDEO
        updatedAt:
          type: string
          description: A data e a hora da última atualização da coluna.
          format: date-time
        updatedBy:
          $ref: '#/components/schemas/SimpleUser'
        updatedByUserId:
          type: integer
          description: O ID do usuário que atualizou a coluna pela última vez.
          format: int32
        width:
          type: integer
          description: Largura da coluna para a interface do HubDB
          format: int32
    SimpleUser:
      required:
        - email
        - firstName
        - id
        - lastName
      type: object
      properties:
        email:
          type: string
          description: O endereço de e-mail do usuário.
        firstName:
          type: string
          description: O nome do usuário.
        id:
          type: string
          description: O identificador exclusivo do usuário.
        lastName:
          type: string
          description: O sobrenome do usuário.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação. Inclua este valor em
            relatórios de erro ou tickets de suporte
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: mais informações sobre o erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou as etapas de correção recomendadas
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    Option:
      required:
        - createdAt
        - id
        - label
        - name
        - order
        - type
        - updatedAt
      type: object
      properties:
        createdAt:
          type: string
          description: A data e hora em que a opção foi criada, no formato ISO 8601.
          format: date-time
        createdBy:
          $ref: '#/components/schemas/SimpleUser'
        createdByUserId:
          type: integer
          description: O ID do usuário que criou a opção.
          format: int32
        id:
          type: string
          description: O ID exclusivo da opção.
        label:
          type: string
          description: Um rótulo amigável que identifica a opção.
        name:
          type: string
          description: Um nome interno atribuído à opção, diferente do rótulo.
        order:
          type: integer
          description: A ordem em que a opção aparece, representada por um número inteiro.
          format: int32
        type:
          type: string
          description: >-
            Indica a categoria ou tipo de dado da opção (por exemplo, string,
            número).
        updatedAt:
          type: string
          description: A data e hora da última atualização da opção, no formato ISO 8601.
          format: date-time
        updatedBy:
          $ref: '#/components/schemas/SimpleUser'
        updatedByUserId:
          type: integer
          description: O ID do usuário que atualizou a opção pela última vez.
          format: int32
      description: A HubSpot property option
    ForeignId:
      required:
        - id
        - name
        - type
      type: object
      properties:
        id:
          type: string
          description: Identificador exclusivo do ID estrangeiro.
        name:
          type: string
          description: Nome do ID estrangeiro.
        type:
          type: string
          description: Tipo do ID estrangeiro.
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: O código de status associado ao detalhe do erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        in:
          type: string
          description: O nome do campo ou parâmetro no qual o erro foi encontrado.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            hubdb.rows.read: ''
            hubdb.rows.write: ''
            hubdb.tables.publish: ''
            hubdb.tables.read: ''
            hubdb.tables.write: ''

````