Atualizar uma tabela existente

curl --request PATCH \
  --url https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowChildTables": true,
  "allowPublicApiAccess": true,
  "columns": [
    {
      "id": 123,
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "createdAt": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "label": "<string>",
          "name": "<string>",
          "order": 123,
          "type": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z",
          "createdByUserId": 123,
          "updatedByUserId": 123
        }
      ],
      "foreignColumnId": 123,
      "foreignTableId": 123,
      "maxNumberOfCharacters": 123,
      "maxNumberOfOptions": 123
    }
  ],
  "dynamicMetaTags": {},
  "enableChildTablePages": true,
  "label": "<string>",
  "name": "<string>",
  "useForPages": true
}
'

{
  "allowChildTables": true,
  "allowPublicApiAccess": true,
  "columnCount": 123,
  "columns": [
    {
      "deleted": true,
      "description": "<string>",
      "id": "<string>",
      "label": "<string>",
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": {
        "email": "<string>",
        "firstName": "<string>",
        "id": "<string>",
        "lastName": "<string>"
      },
      "createdByUserId": 123,
      "foreignColumnId": 123,
      "foreignIds": [
        {
          "id": "<string>",
          "name": "<string>",
          "type": "<string>"
        }
      ],
      "foreignIdsById": {},
      "foreignIdsByName": {},
      "foreignTableId": 123,
      "optionCount": 123,
      "options": [
        {
          "createdAt": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "label": "<string>",
          "name": "<string>",
          "order": 123,
          "type": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z",
          "createdBy": {
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "lastName": "<string>"
          },
          "createdByUserId": 123,
          "updatedBy": {
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "lastName": "<string>"
          },
          "updatedByUserId": 123
        }
      ],
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": {
        "email": "<string>",
        "firstName": "<string>",
        "id": "<string>",
        "lastName": "<string>"
      },
      "updatedByUserId": 123,
      "width": 123
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "deleted": true,
  "deletedAt": "2023-11-07T05:31:56Z",
  "dynamicMetaTags": {},
  "enableChildTablePages": true,
  "id": "<string>",
  "label": "<string>",
  "name": "<string>",
  "published": true,
  "publishedAt": "2023-11-07T05:31:56Z",
  "rowCount": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "useForPages": true,
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>"
  },
  "isOrderedManually": true,
  "updatedBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>"
  }
}

Tabelas

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.

PATCH

cms

hubdb

tables

{tableIdOrName}

draft

Atualizar uma tabela existente

curl --request PATCH \
  --url https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allowChildTables": true,
  "allowPublicApiAccess": true,
  "columns": [
    {
      "id": 123,
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "createdAt": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "label": "<string>",
          "name": "<string>",
          "order": 123,
          "type": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z",
          "createdByUserId": 123,
          "updatedByUserId": 123
        }
      ],
      "foreignColumnId": 123,
      "foreignTableId": 123,
      "maxNumberOfCharacters": 123,
      "maxNumberOfOptions": 123
    }
  ],
  "dynamicMetaTags": {},
  "enableChildTablePages": true,
  "label": "<string>",
  "name": "<string>",
  "useForPages": true
}
'

{
  "allowChildTables": true,
  "allowPublicApiAccess": true,
  "columnCount": 123,
  "columns": [
    {
      "deleted": true,
      "description": "<string>",
      "id": "<string>",
      "label": "<string>",
      "name": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": {
        "email": "<string>",
        "firstName": "<string>",
        "id": "<string>",
        "lastName": "<string>"
      },
      "createdByUserId": 123,
      "foreignColumnId": 123,
      "foreignIds": [
        {
          "id": "<string>",
          "name": "<string>",
          "type": "<string>"
        }
      ],
      "foreignIdsById": {},
      "foreignIdsByName": {},
      "foreignTableId": 123,
      "optionCount": 123,
      "options": [
        {
          "createdAt": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "label": "<string>",
          "name": "<string>",
          "order": 123,
          "type": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z",
          "createdBy": {
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "lastName": "<string>"
          },
          "createdByUserId": 123,
          "updatedBy": {
            "email": "<string>",
            "firstName": "<string>",
            "id": "<string>",
            "lastName": "<string>"
          },
          "updatedByUserId": 123
        }
      ],
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": {
        "email": "<string>",
        "firstName": "<string>",
        "id": "<string>",
        "lastName": "<string>"
      },
      "updatedByUserId": 123,
      "width": 123
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "deleted": true,
  "deletedAt": "2023-11-07T05:31:56Z",
  "dynamicMetaTags": {},
  "enableChildTablePages": true,
  "id": "<string>",
  "label": "<string>",
  "name": "<string>",
  "published": true,
  "publishedAt": "2023-11-07T05:31:56Z",
  "rowCount": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "useForPages": true,
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>"
  },
  "isOrderedManually": true,
  "updatedBy": {
    "email": "<string>",
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>"
  }
}

Supported products

Required Scopes

Autorizações

Authorization

string

header

obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de caminho

tableIdOrName

string

obrigatório

O ID ou nome da tabela HubDB.

Parâmetros de consulta

archived

boolean

Se apenas os resultados que foram arquivados devem ser retornados.

includeForeignIds

boolean

Defina como "true" para preencher os valores de ID externo no resultado.

isGetLocalizedSchema

boolean

Indica se deve recuperar o esquema localizado para a tabela.

Corpo

application/json

allowChildTables

boolean

obrigatório

Especifica se as tabelas secundárias podem ser criadas

allowPublicApiAccess

boolean

obrigatório

Especifica se a tabela pode ser lida pelo público sem autorização

columns

object[]

obrigatório

Lista de colunas na tabela

Show child attributes

dynamicMetaTags

object

obrigatório

Especifica os pares de valores-chave dos campos de metadados com os IDs de coluna associados.

Show child attributes

enableChildTablePages

boolean

obrigatório

Especifica a criação de páginas dinâmicas de vários níveis usando tabelas secundárias

label

string

obrigatório

Rótulo da tabela

name

string

obrigatório

Nome da tabela

useForPages

boolean

obrigatório

Especifica se a tabela pode ser usada para criação de páginas dinâmicas

Resposta

successful operation

allowChildTables

boolean

obrigatório

Especifica se as tabelas secundárias podem ser criadas

allowPublicApiAccess

boolean

obrigatório

Especifica se a tabela pode ser lida pelo público sem autorização

columnCount

integer<int64>

obrigatório

Número de colunas, incluindo as excluídas

columns

object[]

obrigatório

Lista de colunas na tabela

Show child attributes

createdAt

string<date-time>

obrigatório

A data e hora em que a tabela foi criada

deleted

boolean

obrigatório

Especifica se a tabela está marcada como excluída.

deletedAt

string<date-time>

obrigatório

A data e a hora que indica quando a tabela foi excluída.

dynamicMetaTags

object

obrigatório

Especifica os pares de valores-chave dos campos de metadados com os IDs de coluna associados.

Show child attributes

enableChildTablePages

boolean

obrigatório

Especifica a criação de páginas dinâmicas de vários níveis usando tabelas secundárias

string

obrigatório

ID da tabela

label

string

obrigatório

Rótulo da tabela

name

string

obrigatório

Nome da tabela

published

boolean

obrigatório

Indica se a tabela está atualmente publicada.

publishedAt

string<date-time>

obrigatório

A data e hora em que a tabela foi publicada recentemente

rowCount

integer<int32>

obrigatório

Número de linhas na tabela

updatedAt

string<date-time>

obrigatório

A data e hora em que a tabela foi atualizada recentemente

useForPages

boolean

obrigatório

Especifica se a tabela pode ser usada para criação de páginas dinâmicas

createdBy

object

Show child attributes

isOrderedManually

boolean

Indica se as linhas da tabela estão ordenadas manualmente.

updatedBy

object

Show child attributes

Last modified on April 13, 2026

Unpublish a table

Delete a table version

⌘I

Documentation Index

Autorizações

Parâmetros de caminho

Parâmetros de consulta

Corpo

Resposta