API de Temas

Personalize a aparência visual dos seus formulários com propriedades de tema granulares.

A API de Temas permite ler e atualizar o tema visual completo de um formulário. As propriedades de tema controlam cores, fontes, marca e layout tanto do formulário em si quanto de elementos individuais da interface, como botões, indicadores e opções.

Todos os corpos de requisição e resposta usam nomes de campos em snake_case.

Endpoints

GET/api/v1/forms/:id/themePUT/api/v1/forms/:id/theme

Obter Tema do Formulário

GET/api/v1/forms/:id/theme

Recupera todas as propriedades de tema de um formulário.

Parâmetros de Caminho

idstring

O ID do formulário

Resposta

json

{
  "theme_color": "#6366f1",
  "background_color": "#0a0a0a",
  "text_color": "#ffffff",
  "answer_text_color": "#e5e7eb",
  "placeholder_color": "#6b7280",
  "button_color": "#6366f1",
  "button_text_color": "#ffffff",
  "title_color": "#f9fafb",
  "description_color": "#d1d5db",
  "option_text_color": "#e5e7eb",
  "indicator_bg_color": "#1f2937",
  "indicator_text_color": "#9ca3af",
  "font_family": "Inter",
  "font_family_answer": "Inter",
  "font_family_button": "Inter",
  "font_family_description": "Inter",
  "font_family_option": "Inter",
  "font_family_indicator": "Inter",
  "question_font_size": "24px",
  "custom_css": null,
  "show_progress_bar": true,
  "branding_logo_url": null,
  "branding_footer_text": null,
  "hide_branding": false,
  "top_logo_url": null,
  "top_logo_size": null,
  "top_logo_alignment": "center",
  "top_logo_css": null,
  "watermark_css": null,
  "welcome_title": "Welcome",
  "welcome_description": null,
  "welcome_button_text": "Start",
  "thank_you_title": "Thank you!",
  "thank_you_description": null
}

Exemplos de Código

bash

curl -X GET "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/theme" \
  -H "Authorization: Bearer YOUR_API_KEY"

Atualizar Tema do Formulário

PUT/api/v1/forms/:id/theme

Atualiza as propriedades de tema de um formulário. Inclua apenas os campos que você deseja alterar. Os campos não especificados mantêm seus valores atuais.

Parâmetros de Caminho

idstring

O ID do formulário

Corpo da Requisição

Inclua qualquer combinação de propriedades de tema da Referência de Propriedades do Tema abaixo.

Exemplo de Requisição

json

{
  "theme_color": "#2563eb",
  "background_color": "#ffffff",
  "text_color": "#111827",
  "button_color": "#2563eb",
  "button_text_color": "#ffffff",
  "font_family": "Poppins",
  "question_font_size": "28px",
  "show_progress_bar": true,
  "hide_branding": true,
  "top_logo_url": "https://cdn.example.com/logo.svg",
  "top_logo_size": "140px",
  "top_logo_alignment": "left"
}

Resposta

Retorna o objeto do tema completo e atualizado (mesmo esquema de Obter Tema do Formulário).

Exemplos de Código

bash

curl -X PUT "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/theme" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "theme_color": "#2563eb",
    "background_color": "#ffffff",
    "text_color": "#111827",
    "font_family": "Poppins"
  }'

Referência de Propriedades do Tema

Abaixo está a lista completa de propriedades de tema disponíveis para personalização.

Propriedades de Cor

theme_colorstring

Cor de destaque primária usada em todo o formulário (anéis de foco, realces). Padrão: "#6366f1"

background_colorstring

Cor de fundo do formulário. Padrão: "#0a0a0a"

text_colorstring

Cor primária do texto da pergunta. Padrão: null

answer_text_colorstring

Cor do texto digitado nos campos de resposta. Padrão: null

placeholder_colorstring

Cor do texto de placeholder para campos vazios. Padrão: null

button_colorstring

Cor de fundo dos botões de enviar/avançar. Padrão: null

button_text_colorstring

Cor do texto dos botões de enviar/avançar. Padrão: null

title_colorstring

Cor do texto do título da pergunta (sobrescreve text_color para títulos). Padrão: null

description_colorstring

Cor do texto da descrição da pergunta. Padrão: null

option_text_colorstring

Cor do texto das opções de múltipla escolha e menu suspenso. Padrão: null

indicator_bg_colorstring

Cor de fundo do indicador de etapa/número da pergunta. Padrão: null

indicator_text_colorstring

Cor do texto do indicador de etapa/número da pergunta. Padrão: null

Propriedades de Fonte

font_familystring

Família de fonte para os títulos das perguntas. Suporta qualquer Google Font ou fonte do sistema. Padrão: null

font_family_answerstring

Família de fonte para o texto dos campos de resposta. Padrão: null

font_family_buttonstring

Família de fonte para os rótulos dos botões. Padrão: null

font_family_descriptionstring

Família de fonte para as descrições das perguntas. Padrão: null

font_family_optionstring

Família de fonte para os rótulos das opções de múltipla escolha. Padrão: null

font_family_indicatorstring

Família de fonte para os indicadores de etapa/número da pergunta. Padrão: null

question_font_sizestring

Tamanho da fonte para os títulos das perguntas (por exemplo, "24px", "1.5rem"). Padrão: null

Layout e Progresso

show_progress_barboolean

Se uma barra de progresso deve ser exibida no topo do formulário. Padrão: true

show_question_navboolean

Se as setas de navegação e o contador de perguntas (por exemplo, 3 / 16) devem ser exibidos no canto inferior direito de formulários de uma pergunta por vez (NueForm). Padrão: true

Marca

branding_logo_urlstring

URL de um logotipo da marca exibido na área do rodapé. Padrão: null

branding_footer_textstring

Texto personalizado exibido no rodapé do formulário. Padrão: null

hide_brandingboolean

Oculta o rodapé padrão com a marca NueForm. Padrão: false

top_logo_urlstring

URL de um logotipo exibido no topo do formulário. Padrão: null

top_logo_sizestring

Tamanho do logotipo do topo (por exemplo, "120px", "80px"). Padrão: null

top_logo_alignmentstring

Alinhamento horizontal do logotipo do topo: "left", "center", "right". Padrão: null

top_logo_cssstring

CSS personalizado aplicado ao contêiner do logotipo do topo. Padrão: null

watermark_cssstring

CSS personalizado aplicado à marca d'água. Padrão: null

Telas de Boas-Vindas e Agradecimento

welcome_titlestring

Texto do título exibido na tela de boas-vindas. Padrão: null

welcome_descriptionstring

Texto de descrição na tela de boas-vindas. Padrão: null

welcome_button_textstring

Rótulo do botão na tela de boas-vindas. Padrão: "Start"

thank_you_titlestring

Texto do título na tela de conclusão. Padrão: "Thank you!"

thank_you_descriptionstring

Texto de descrição na tela de conclusão. Padrão: null

Avançado

custom_cssstring

CSS arbitrário injetado no renderizador do formulário. Use para personalizações avançadas que as propriedades de tema não cobrem. Padrão: null

Respostas de Erro

Respostas de erro padrão retornadas por esses endpoints.

Códigos de Erro

401Unauthorized

Chave de API ausente ou inválida

403Forbidden

Permissões insuficientes para formulários de equipe

404Not Found

Formulário não encontrado

500Server Error

Erro interno do servidor

Exemplo de Erro

json

{
  "error": "Form not found"
}

Última atualização: 20 de julho de 2026