AtomicatAtomicat
Website
  • English
  • Español
  • Português
Atomicat
  • Site
  • App
  • Central de ajuda
Documentação da API
  • Introdução
  • Autenticação
  • Referência da API
AtomicatAtomicat

© 2026 Atomicat. All rights reserved.

instagramInstagramyoutubeYouTubewhatsappWhatsApp
Information
Account
    Obter a conta autenticadagetBaixar o documento OpenAPIget
Projects
    Listar projetosgetCriar um projetopostBuscar projetosgetObter um projetogetExcluir um projeto sem usodeleteAtualizar um projetopatch
Sites
    Listar sitesgetCriar um sitepostBuscar sitesgetObter um siteget
Pages
    Listar páginasgetCriar uma página em brancopostCriar uma página a partir de um modelopostDuplicar uma páginapostAtualizar metadados da páginapatchAtualizar conteúdo mapeadopatchSubstituir variáveis do modelopostVerificar se a página pode ser publicadapostPublicar uma páginapostObter uma páginagetExcluir uma páginadeleteListar modelosgetBuscar modelosgetBuscar páginasget
Builder
    Ler o construtor da páginagetLer um nó do construtorgetAtualizar campos do nópatchSubstituir um nópatchAtualizar o atraso de revelaçãopatchLer campos de conteúdo editáveisget
Quizzes
    Listar quizzesgetCriar uma página de quizpostBuscar quizzesgetObter um quizgetCriar um quiz a partir de um modelopost
Funnels
    Listar funisgetCriar um funilpostAtualizar um funilpatchBuscar funisgetObter um funilget
Videos
    Listar vídeosgetAtualizar o playerpatchBuscar vídeosgetObter um vídeoget
Products
    Listar produtosgetCriar um produtopostAtualizar um produtopatchBuscar produtosgetObter um produtogetExcluir um produtodelete
Leads
    Buscar leadsget
Analytics
    Obter contagens da contaget
Webhooks
    Assinar um eventopostDesativar uma assinaturadeleteObter um payload de exemploget
Schemas
Atomicat API
Atomicat API

Schemas

Download schema

Error

error
​string · required

Código estável, como invalid_request ou page_not_found.

message
​string · required

Explicação legível.

Deleted

success
​boolean

true quando a exclusão teve sucesso.

id
​string

Id do registro excluído.

deleted
​boolean

true quando o registro foi removido.

Account

id
​string

Id da conta.

email
​string | null

Email da conta.

name
​string

Nome de exibição.

plan
​

Nome do plano quando existir.

workspace_id
​string

O mesmo valor de id.

Project

id
​string

Id do projeto.

name
​string

Nome.

description
​string | null

Descrição.

context
​string | null

Brief da marca. Presente ao criar e atualizar.

active
​boolean

false quando o projeto está inativo.

created_at
​string | null

Timestamp ISO-8601.

updated_at
​string | null

Timestamp ISO-8601.

ProjectCreate

name
​string · required

Nome do projeto.

Example: Spring campaign
description
​string · minLength: 50 · required

Pelo menos 50 caracteres.

Example: Campaign assets for the spring launch across offers and traffic sources.
context
​string · minLength: 200 · required

Pelo menos 200 caracteres sobre a marca e a oferta.

Example: Spring campaign sells a 6-week fitness program for busy professionals. The brand voice is direct and encouraging. The offer is a starter kit plus one coaching call. Pages should speak to people who started short workouts and quit, explain the weekly plan and the support included, and state the refund window before the call to action.

ProjectUpdate

name
​string

Novo nome.

description
​string

Nova descrição.

context
​string

Novo brief.

Site

id
​string

Id do site.

name
​string

Nome de exibição, muitas vezes o domínio.

site_name
​string | null

Nome salvo no site.

domain
​string | null

Domínio público.

custom_domain
​string | null

Domínio próprio, quando conectado.

atomic_domain
​string | null

Domínio fornecido pela Atomicat.

project_id
​string | null

Id do projeto.

status
​string | null

Status do site quando existir.

created_at
​string | null

Timestamp ISO-8601.

updated_at
​string | null

Timestamp ISO-8601.

SiteCreated

id
​string

Id do site.

site_id
​string

O mesmo valor de id.

name
​string | null

Nome do site.

atomic_domain
​string | null

Domínio Atomicat.

url
​string | null

URL pública.

project_id
​string | null

Id do projeto.

custom_domain_instructions
​

Instruções de DNS do domínio próprio, quando devolvidas.

SiteCreate

name
​string

Nome do site.

description
​string

Descrição.

project_id
​string

Projeto ao qual o site será ligado.

Page

id
​string

Id da página.

name
​string

Nome de exibição. Inclui o site entre parênteses quando a página está em um site.

page_name
​string

Nome sem o sufixo do site.

status
​string

published ou draft.

is_quiz
​boolean

true quando a página é um quiz.

project_id
​string | null

Id do projeto.

site_id
​string | null

Id do site quando a página está ligada a um site.

site_name
​string | null

Nome do site.

domain
​string | null

Domínio publicado.

slug
​string | null

Caminho no site. Vazio significa a raiz.

url
​string | null

URL pública depois de publicar.

edit_url
​string

Link da página no construtor.

created_at
​string | null

Timestamp ISO-8601.

updated_at
​string | null

Timestamp ISO-8601.

published_at
​string | null

Hora de publicação ISO-8601.

PageCreate

name
​string · required

Nome da página.

project_id
​string

Id do projeto.

PageFromTemplate

template_id
​string · required

Id do modelo de GET /templates.

name
​string

Nome da nova página.

site_id
​string

Site para ligar, se houver.

project_id
​string

Id do projeto.

PageDuplicate

page_id
​string · required

Página a copiar.

new_name
​string

Nome da cópia.

PageDuplicateResult

id
​string

Id da nova página.

name
​string

Novo nome.

page_name
​string

Novo nome.

source_page_id
​string

Id da página copiada.

edit_url
​string

URL do construtor.

PageMetadata

page_id
​string · required

Id da página.

name
​string

Novo nome.

project_id
​string

Novo id de projeto.

tags
​

Array de tags, ou texto separado por vírgulas.

product_label
​string

Rótulo de produto. produkt é aceito como alias.

PageMetadataResult

id
​string

Id da página.

page_id
​string

Id da página.

updated
​boolean

true quando foi salvo.

name
​string | null

Nome depois da atualização.

project_id
​string | null

Id de projeto depois da atualização.

tags
​

Tags depois da atualização.

product_label
​string | null

Rótulo depois da atualização.

PageIdBody

page_id
​string · required

Id da página.

PageContentUpdate

page_id
​string · required

Id da página.

​object · required

Mapa de chaves de conteúdo para novos valores. Um string JSON também é aceito.

PageContentResult

id
​string

Id da página.

page_id
​string

Id da página.

success
​boolean

true quando a solicitação terminou.

applied_count
​number

Quantidade de campos atualizados.

changed_section_count
​number

Quantidade de seções reescritas.

missing_count
​number

Quantidade de chaves não encontradas.

applied
​string

Texto JSON das atualizações aplicadas.

missing
​string

Texto JSON das chaves não aplicadas.

PageVariables

page_id
​string · required

Id da página.

​object · required

Nome do marcador para o texto. Um string JSON também é aceito.

PageVariablesResult

id
​string

Id da página.

page_id
​string

Id da página.

success
​boolean

true quando terminou.

replacement_count
​number

Quantidade de substituições.

changed_section_count
​number

Seções reescritas.

replaced_variables
​string

Texto JSON das variáveis substituídas.

remaining_variables
​string

Texto JSON das variáveis que ainda estão na página.

remaining_variable_count
​number

Quantidade de variáveis restantes.

PageValidation

id
​string

Id da página.

page_id
​string

Id da página.

ready_to_publish
​boolean

true quando não há problemas.

issue_count
​number

Quantidade de problemas.

issues
​string

Texto JSON dos problemas.

field_count
​number

Quantidade de campos editáveis.

remaining_variable_count
​number

Variáveis que ainda estão na página.

remaining_variables
​string

Texto JSON das variáveis restantes.

PagePublish

page_id
​string · required

Id da página.

site_id
​string · required

Site que vai hospedar a página.

slug
​string

Caminho no site. Omita ou envie vazio para a raiz.

PagePublishResult

id
​string

Id da página.

page_id
​string

Id da página.

site_id
​string

Id do site.

success
​boolean

true quando a publicação teve sucesso.

url
​string | null

URL pública.

domain
​string | null

Domínio publicado.

slug
​string

Caminho publicado.

revision_saved
​boolean

true quando uma revisão foi salva.

revision_warning
​string | null

Aviso se a revisão não pôde ser salva.

PageDelay

page_id
​string · required

Id da página.

time
​number

Atraso em segundos.

sync_with_video
​boolean

Revelar em sincronia com um vídeo.

scroll_into_view
​boolean

Rolar a seção para a vista.

video_node_id
​string

Id do nó de vídeo.

PageDelayResult

id
​string

Id da página.

page_id
​string

Id da página.

updated
​boolean

true quando foi salvo.

​object

Configurações de atraso salvas.

BuilderSummary

id
​string

Id da página.

page_id
​string

Id da página.

​object

Resumo do construtor, com a árvore se include_tree for true.

BuilderNode

id
​string

Id do nó.

page_id
​string

Id da página.

node_id
​string

Id do nó.

path
​string | null

Local do nó na árvore.

summary
​

Resumo curto quando o construtor devolve.

​object

O objeto do nó.

BuilderNodeFields

page_id
​string · required

Id da página.

node_id
​string · required

Id do nó.

​object · required

Deve incluir misc, style ou ambos.

node_type
​string

Tipo de nó opcional.

BuilderNodeUpdate

id
​string

Id do nó.

page_id
​string

Id da página.

node_id
​string

Id do nó.

updated
​boolean

true quando foi salvo.

path
​string | null

Caminho do nó.

BuilderNodeReplace

page_id
​string · required

Id da página.

node_id
​string · required

Id do nó a substituir.

​object · required

Nó completo de substituição. Um string JSON também é aceito.

BuilderNodeReplaceResult

id
​string

Id do nó.

page_id
​string

Id da página.

node_id
​string

Id do nó.

updated
​boolean

true quando foi substituído.

path
​string | null

Caminho do nó.

builder_warnings
​string

Texto JSON de avisos.

ContentMap

id
​string | null

Id da página.

page_id
​string | null

Id da página.

page_name
​string | null

Nome da página.

field_count
​number

Quantidade de campos editáveis.

variable_count
​number

Quantidade de variáveis.

variables
​string

Texto JSON dos nomes das variáveis.

fields
​string

Texto JSON dos campos editáveis.

ready_for_variable_replacement
​boolean

true quando a página ainda tem variáveis.

Template

id
​string

Id do modelo.

name
​string

Nome.

template_name
​string

Igual a name.

category
​string | null

Categoria.

type
​string

Tipo, normalmente page.

description
​string | null

Descrição.

preview_url
​string | null

URL de pré-visualização.

image_url
​string | null

URL da miniatura.

Quiz

id
​string

Id do quiz (qid).

name
​string

Nome de exibição, com o nome da página quando conhecido.

quiz_name
​string

Nome do quiz.

page_id
​string | null

Página que hospeda o quiz.

page_name
​string | null

Nome da página.

site_id
​string | null

Id do site.

project_id
​string | null

Id do projeto.

created_at
​string | null

Timestamp ISO-8601.

updated_at
​string | null

Timestamp ISO-8601.

QuizPage

Uma página de quiz recém-criada. id é o id da página. Listagens posteriores devolvem o qid, que pode ser diferente.
id
​string

Id da página.

quiz_id
​string

Igual a id na criação.

is_quiz
​boolean

Sempre true.

name
​string

Nome.

page_name
​string

Nome.

project_id
​string | null

Id do projeto.

site_id
​string | null

Id do site.

edit_url
​string

URL do construtor.

QuizCreate

name
​string · required

Nome da página de quiz.

project_id
​string

Id do projeto.

site_id
​string

Id do site.

Funnel

id
​string

Id do funil.

name
​string

Nome.

site_id
​string | null

Id do site.

project_id
​string | null

Id do projeto.

status
​string | null

Status.

​array

Ids de página ou passos salvos no funil.

page_ids
​string

Ids separados por vírgula quando pages é um array de ids.

​object[]

Passos quando o funil os guarda.

created_at
​string | null

Timestamp ISO-8601.

updated_at
​string | null

Timestamp ISO-8601.

FunnelPage

pageId
​string

Id de uma página existente.

url
​string

URL externa, quando não há pageId.

pageType
​string

Tipo do passo, como presell, sales ou thankyou.

FunnelCreate

name
​string · required

Nome do funil.

project_id
​string

Id do projeto.

​FunnelPage[]

Passos. Cada um precisa de pageId ou url.

FunnelUpdate

funnel_id
​string · required

Id do funil.

name
​string

Novo nome.

​FunnelPage[]

Video

id
​string | null

Id do vídeo.

video_id
​string | null

Igual a id.

name
​string | null

Nome.

title
​string | null

Título do player.

status
​string | null

Status de codificação ou reprodução.

duration
​

Duração em segundos quando o player a devolve.

thumbnail_url
​string | null

URL da miniatura.

project_id
​string | null

Id do projeto.

created_at
​string | null

Data de criação.

updated_at
​string | null

Data de atualização.

VideoUpdate

video_id
​string · required

Id do vídeo.

name
​string

Nome na biblioteca.

title
​string

Título do player.

language
​string

Idioma do player.

project_id
​string

Id do projeto.

primary_color
​string

Cor de destaque do player.

controls
​boolean

Mostrar controles.

autoplay
​boolean

Iniciar a reprodução automaticamente.

muted
​boolean

Iniciar sem som.

loop
​boolean

Repetir a reprodução.

Product

id
​string

Id do produto.

name
​string

Nome.

type
​string

simple ou bundle.

sku
​string | null

SKU.

description
​string | null

Descrição.

image
​string | null

URL da imagem.

show_full_product
​boolean

Mostrar o bloco completo do produto.

price
​number

Preço.

compare_price
​number

Preço de comparação.

rating
​string | null

Rótulo de avaliação.

rating_count
​string | null

Rótulo da quantidade de avaliações.

project_id
​string | null

Id do projeto.

cta_text
​string | null

Texto do botão.

cta_url
​string | null

URL do botão.

cta_target
​boolean

Abrir a URL em uma nova aba.

use_single_cta_link
​boolean

Usar um único link de chamada.

bundle_discount
​number

Desconto do bundle.

bundle_item_count
​number

Quantidade de itens do bundle.

tiers_enabled
​boolean

Os níveis de quantidade estão ativos.

subscription_enabled
​boolean

A opção de assinatura está ativa.

created_at
​string | null

Timestamp ISO-8601.

updated_at
​string | null

Timestamp ISO-8601.

ProductWrite

name
​string · required

Nome.

type
​string · enum

Padrão simple.

Enum values:
simple
bundle
project_id
​string

Id do projeto.

sku
​string

SKU.

description
​string

Descrição.

image
​string

URL da imagem.

price
​number

Preço.

compare_price
​number

Preço de comparação.

cta_text
​string

Texto do botão.

cta_url
​string

URL do botão.

show_full_product
​boolean

Mostrar o bloco completo.

cta_target
​boolean

Abrir a URL em uma nova aba.

use_single_cta_link
​boolean

Usar um único link.

rating
​string

Rótulo de avaliação. Padrão 4.9 se enviado vazio.

rating_count
​string

Rótulo da quantidade.

trust_badges_json
​

Array de rótulos, ou um string JSON.

variants_json
​

Array de { id, name, image }, ou um string JSON.

tiers_enabled
​boolean

Ativar níveis de quantidade.

tiers_json
​

Objetos de nível, ou um string JSON.

bundle_items_json
​

Obrigatório quando type é bundle.

bundle_discount
​number

Desconto do bundle.

subscription_json
​

Objeto com enabled, discountPercent e benefits.

ProductUpdate

product_id
​string · required

Id do produto.

name
​string

Novo nome.

type
​string · enum
Enum values:
simple
bundle
sku
​string

SKU.

description
​string

Descrição.

image
​string

URL da imagem.

price
​number

Preço.

compare_price
​number

Preço de comparação.

project_id
​string

Id do projeto.

cta_text
​string

Texto do botão.

cta_url
​string

URL do botão.

show_full_product
​boolean

Mostrar o bloco completo.

cta_target
​boolean

Abrir em uma nova aba.

use_single_cta_link
​boolean

Usar um único link.

rating
​string

Rótulo de avaliação.

rating_count
​string

Rótulo da quantidade.

trust_badges_json
​

Rótulos.

variants_json
​

Objetos de variante.

tiers_enabled
​boolean

Ativar níveis.

tiers_json
​

Objetos de nível.

bundle_items_json
​

Itens do bundle.

bundle_discount
​number

Desconto.

subscription_json
​

Configurações de assinatura.

Lead

id
​string

Id do lead.

lead_id
​string

Igual a id.

type
​string

form ou quiz.

name
​string | null

Nome.

first_name
​string | null

Nome.

last_name
​string | null

Sobrenome.

email
​string | null

Email.

phone
​string | null

Telefone.

form_id
​string | null

Id do formulário. Presente em leads de formulário.

form_name
​string | null

Nome do formulário.

quiz_id
​string | null

Id do quiz. Presente em leads de quiz.

quiz_name
​string | null

Nome do quiz.

page_id
​string | null

Id da página.

page_url
​string | null

URL da página.

project_id
​string | null

Id do projeto.

site_id
​string | null

Id do site.

abandoned
​boolean

true quando um lead de formulário foi abandonado.

is_completed
​boolean

Presente em leads de quiz.

​object

Campos brutos do formulário.

​object

Respostas brutas do quiz.

created_at
​string | null

Timestamp ISO-8601.

Analytics

pages
​number

Quantidade de páginas.

sites
​number

Quantidade de sites.

funnels
​number

Quantidade de funis.

products
​number

Quantidade de produtos.

projects
​number

Quantidade de projetos.

form_leads
​number

Quantidade de leads de formulário.

quiz_leads
​number

Quantidade de leads de quiz.

HookCreate

target_url
​string · uri · required

URL HTTPS pública que recebe o evento.

event_type
​string · enum · required

Evento a assinar.

Enum values:
form_lead.created
quiz_lead.created
page.published
page.created
product.created
funnel.created
site.created
project.created
​object

Objeto de filtro opcional salvo com a assinatura.

HookSubscription

id
​string

Id da assinatura. Envie para DELETE /hooks/{subscriptionId}.

event_type
​string

Evento assinado.

active
​boolean

true até a assinatura ser desativada.

created_at
​string

Timestamp ISO-8601.

On this page
  • Error
  • Deleted
  • Account
  • Project
  • ProjectCreate
  • ProjectUpdate
  • Site
  • SiteCreated
  • SiteCreate
  • Page
  • PageCreate
  • PageFromTemplate
  • PageDuplicate
  • PageDuplicateResult
  • PageMetadata
  • PageMetadataResult
  • PageIdBody
  • PageContentUpdate
  • PageContentResult
  • PageVariables
  • PageVariablesResult
  • PageValidation
  • PagePublish
  • PagePublishResult
  • PageDelay
  • PageDelayResult
  • BuilderSummary
  • BuilderNode
  • BuilderNodeFields
  • BuilderNodeUpdate
  • BuilderNodeReplace
  • BuilderNodeReplaceResult
  • ContentMap
  • Template
  • Quiz
  • QuizPage
  • QuizCreate
  • Funnel
  • FunnelPage
  • FunnelCreate
  • FunnelUpdate
  • Video
  • VideoUpdate
  • Product
  • ProductWrite
  • ProductUpdate
  • Lead
  • Analytics
  • HookCreate
  • HookSubscription