API atual/Referência completa/Theme Builder

Grupos de cabeçalho e rodapé

Lista os grupos de cabeçalho e rodapé do tema e substitui as seções de um deles.

O grupo de seções é o cabeçalho ou o rodapé do tema, compartilhado por todas as páginas. Cada tema tem dois grupos, header e footer, criados com o tema. O conteúdo deles é uma lista de seções, como nos modelos. Não há rota para criar ou excluir grupos.

Listar grupos

Devolve os grupos do tema, sem as seções. Para ver as seções use listar seções com group_id.

GET/api/v1/admin/theme-builder/themes/{id}/groupsAdmin

Listar os grupos do tema

Requer o privilégio manage_theme.

Parâmetros de caminho

iduuidobrigatório

Id do tema.

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/admin/theme-builder/themes/fb9134bb-7063-46a5-96f8-bad686d1c69b/groups" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Grupos

json

{
  "groups": [
    {
      "id": "8464070a-286d-4cfe-9816-c3a3a8282322",
      "theme_id": "fb9134bb-7063-46a5-96f8-bad686d1c69b",
      "group_type": "header",
      "name": "Header",
      "created_at": "2026-04-07T02:46:02.491306Z",
      "updated_at": "2026-04-07T02:46:02.491306Z"
    }
  ]
}

Campos da resposta

groupsarray

Grupos.

iduuid

Id do grupo.

theme_iduuid

Tema dono.

group_typestring

header ou footer.

namestring

Nome.

created_atstring

Criação (RFC 3339).

updated_atstring

Última alteração (RFC 3339).

Erros

Status	Quando	Corpo de exemplo
401	Sem token, token inválido ou expirado.	`{"error":"invalid or expired token"}`
403	Seu usuário não tem o privilégio `manage_theme`.	`{"error":"insufficient privileges","required":"manage_theme"}`
500	O id do caminho não é um UUID. Esta rota não valida antes e devolve `500` com a mensagem do banco em português.	`{"error":"failed to get section groups","detail":"o valor \"xx\" não é um uuid válido. Envie o identificador completo, com os 36 caracteres e os hífens. Corrija o campo e reenvie."}`
500	Falha de banco de dados ou dado inválido para a coluna.	`{"error":"failed to get section groups","detail":"..."}`

Salvar seções do grupo

Apaga as seções atuais do grupo (e os blocos delas) e cria as da lista, na ordem do array, em uma transação. Como em salvar todas as seções, os blocos não são recriados.

PUT/api/v1/admin/theme-builder/themes/{themeId}/groups/{groupId}Admin

Substituir todas as seções de um grupo

Requer o privilégio manage_theme.

Parâmetros de caminho

themeIduuidobrigatório

Id do tema. Não é verificado pela rota.

groupIduuidobrigatório

Id do grupo.

Corpo da requisição

sectionsobject[]obrigatório

Seções, na ordem final.

section_definition_iduuidobrigatório

Definição da seção.

namestring

Nome da instância.

settings_valuesobjectpadrão: {}

Valores dos campos da definição, por key.

sort_orderinteger

Ignorado: a ordem é a do array.

custom_cssstring

CSS livre da seção.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/theme-builder/themes/fb9134bb-7063-46a5-96f8-bad686d1c69b/groups/8464070a-286d-4cfe-9816-c3a3a8282322" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sections": [
      {
        "section_definition_id": "49ee1ac9-b950-4526-8ffd-571caae96a45",
        "name": "Rodapé",
        "settings_values": {
          "heading": "Fale conosco"
        }
      }
    ]
  }'

Resposta

200Seções salvas

json

{
  "message": "group sections saved"
}

Erros

Status	Quando	Corpo de exemplo
400	Corpo JSON inválido.	`{"error":"invalid request body","detail":"unexpected EOF"}`
400	`groupId` vazio.	`{"error":"group id is required"}`
401	Sem token, token inválido ou expirado.	`{"error":"invalid or expired token"}`
403	Seu usuário não tem o privilégio `manage_theme`.	`{"error":"insufficient privileges","required":"manage_theme"}`
500	Falha de banco de dados ou dado inválido para a coluna.	`{"error":"failed to bulk save group sections","detail":"..."}`

Veja também

API atual/Referência completa/Theme Builder

Grupos de cabeçalho e rodapé

Lista os grupos de cabeçalho e rodapé do tema e substitui as seções de um deles.

Listar grupos

Devolve os grupos do tema, sem as seções. Para ver as seções use listar seções com group_id.

GET/api/v1/admin/theme-builder/themes/{id}/groupsAdmin

Listar os grupos do tema

Requer o privilégio manage_theme.

Parâmetros de caminho

iduuidobrigatório

Id do tema.

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/admin/theme-builder/themes/fb9134bb-7063-46a5-96f8-bad686d1c69b/groups" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Grupos

json

{
  "groups": [
    {
      "id": "8464070a-286d-4cfe-9816-c3a3a8282322",
      "theme_id": "fb9134bb-7063-46a5-96f8-bad686d1c69b",
      "group_type": "header",
      "name": "Header",
      "created_at": "2026-04-07T02:46:02.491306Z",
      "updated_at": "2026-04-07T02:46:02.491306Z"
    }
  ]
}

Campos da resposta

groupsarray

Grupos.

iduuid

Id do grupo.

theme_iduuid

Tema dono.

group_typestring

header ou footer.

namestring

Nome.

created_atstring

Criação (RFC 3339).

updated_atstring

Última alteração (RFC 3339).

Erros

Status	Quando	Corpo de exemplo
401	Sem token, token inválido ou expirado.	`{"error":"invalid or expired token"}`
403	Seu usuário não tem o privilégio `manage_theme`.	`{"error":"insufficient privileges","required":"manage_theme"}`
500	O id do caminho não é um UUID. Esta rota não valida antes e devolve `500` com a mensagem do banco em português.	`{"error":"failed to get section groups","detail":"o valor \"xx\" não é um uuid válido. Envie o identificador completo, com os 36 caracteres e os hífens. Corrija o campo e reenvie."}`
500	Falha de banco de dados ou dado inválido para a coluna.	`{"error":"failed to get section groups","detail":"..."}`

Salvar seções do grupo

Apaga as seções atuais do grupo (e os blocos delas) e cria as da lista, na ordem do array, em uma transação. Como em salvar todas as seções, os blocos não são recriados.

PUT/api/v1/admin/theme-builder/themes/{themeId}/groups/{groupId}Admin

Substituir todas as seções de um grupo

Requer o privilégio manage_theme.

Parâmetros de caminho

themeIduuidobrigatório

Id do tema. Não é verificado pela rota.

groupIduuidobrigatório

Id do grupo.

Corpo da requisição

sectionsobject[]obrigatório

Seções, na ordem final.

section_definition_iduuidobrigatório

Definição da seção.

namestring

Nome da instância.

settings_valuesobjectpadrão: {}

Valores dos campos da definição, por key.

sort_orderinteger

Ignorado: a ordem é a do array.

custom_cssstring

CSS livre da seção.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/theme-builder/themes/fb9134bb-7063-46a5-96f8-bad686d1c69b/groups/8464070a-286d-4cfe-9816-c3a3a8282322" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sections": [
      {
        "section_definition_id": "49ee1ac9-b950-4526-8ffd-571caae96a45",
        "name": "Rodapé",
        "settings_values": {
          "heading": "Fale conosco"
        }
      }
    ]
  }'

Resposta

200Seções salvas

json

{
  "message": "group sections saved"
}

Erros

Status	Quando	Corpo de exemplo
400	Corpo JSON inválido.	`{"error":"invalid request body","detail":"unexpected EOF"}`
400	`groupId` vazio.	`{"error":"group id is required"}`
401	Sem token, token inválido ou expirado.	`{"error":"invalid or expired token"}`
403	Seu usuário não tem o privilégio `manage_theme`.	`{"error":"insufficient privileges","required":"manage_theme"}`
500	Falha de banco de dados ou dado inválido para a coluna.	`{"error":"failed to bulk save group sections","detail":"..."}`