Error
errorCódigo estável, como invalid_request ou page_not_found.
messageExplicação legível.
Deleted
successtrue quando a exclusão teve sucesso.
idId do registro excluído.
deletedtrue quando o registro foi removido.
Account
idId da conta.
emailEmail da conta.
nameNome de exibição.
planNome do plano quando existir.
workspace_idO mesmo valor de id.
Project
idId do projeto.
nameNome.
descriptionDescrição.
contextBrief da marca. Presente ao criar e atualizar.
activefalse quando o projeto está inativo.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
ProjectCreate
nameNome do projeto.
descriptionPelo menos 50 caracteres.
contextPelo menos 200 caracteres sobre a marca e a oferta.
Site
idId do site.
nameNome de exibição, muitas vezes o domínio.
site_nameNome salvo no site.
domainDomínio público.
custom_domainDomínio próprio, quando conectado.
atomic_domainDomínio fornecido pela Atomicat.
project_idId do projeto.
statusStatus do site quando existir.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
SiteCreated
idId do site.
site_idO mesmo valor de id.
nameNome do site.
atomic_domainDomínio Atomicat.
urlURL pública.
project_idId do projeto.
custom_domain_instructionsInstruções de DNS do domínio próprio, quando devolvidas.
SiteCreate
nameNome do site.
descriptionDescrição.
project_idProjeto ao qual o site será ligado.
Page
idId da página.
nameNome de exibição. Inclui o site entre parênteses quando a página está em um site.
page_nameNome sem o sufixo do site.
statuspublished ou draft.
is_quiztrue quando a página é um quiz.
project_idId do projeto.
site_idId do site quando a página está ligada a um site.
site_nameNome do site.
domainDomínio publicado.
slugCaminho no site. Vazio significa a raiz.
urlURL pública depois de publicar.
edit_urlLink da página no construtor.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
published_atHora de publicação ISO-8601.
PageFromTemplate
template_idId do modelo de GET /templates.
nameNome da nova página.
site_idSite para ligar, se houver.
project_idId do projeto.
PageDuplicateResult
idId da nova página.
nameNovo nome.
page_nameNovo nome.
source_page_idId da página copiada.
edit_urlURL do construtor.
PageMetadata
page_idId da página.
nameNovo nome.
project_idNovo id de projeto.
tagsArray de tags, ou texto separado por vírgulas.
product_labelRótulo de produto. produkt é aceito como alias.
PageMetadataResult
idId da página.
page_idId da página.
updatedtrue quando foi salvo.
nameNome depois da atualização.
project_idId de projeto depois da atualização.
tagsTags depois da atualização.
product_labelRótulo depois da atualização.
PageContentUpdate
page_idId da página.
Mapa de chaves de conteúdo para novos valores. Um string JSON também é aceito.
PageContentResult
idId da página.
page_idId da página.
successtrue quando a solicitação terminou.
applied_countQuantidade de campos atualizados.
changed_section_countQuantidade de seções reescritas.
missing_countQuantidade de chaves não encontradas.
appliedTexto JSON das atualizações aplicadas.
missingTexto JSON das chaves não aplicadas.
PageVariables
page_idId da página.
Nome do marcador para o texto. Um string JSON também é aceito.
PageVariablesResult
idId da página.
page_idId da página.
successtrue quando terminou.
replacement_countQuantidade de substituições.
changed_section_countSeções reescritas.
replaced_variablesTexto JSON das variáveis substituídas.
remaining_variablesTexto JSON das variáveis que ainda estão na página.
remaining_variable_countQuantidade de variáveis restantes.
PageValidation
idId da página.
page_idId da página.
ready_to_publishtrue quando não há problemas.
issue_countQuantidade de problemas.
issuesTexto JSON dos problemas.
field_countQuantidade de campos editáveis.
remaining_variable_countVariáveis que ainda estão na página.
remaining_variablesTexto JSON das variáveis restantes.
PagePublish
page_idId da página.
site_idSite que vai hospedar a página.
slugCaminho no site. Omita ou envie vazio para a raiz.
PagePublishResult
idId da página.
page_idId da página.
site_idId do site.
successtrue quando a publicação teve sucesso.
urlURL pública.
domainDomínio publicado.
slugCaminho publicado.
revision_savedtrue quando uma revisão foi salva.
revision_warningAviso se a revisão não pôde ser salva.
PageDelay
page_idId da página.
timeAtraso em segundos.
sync_with_videoRevelar em sincronia com um vídeo.
scroll_into_viewRolar a seção para a vista.
video_node_idId do nó de vídeo.
PageDelayResult
idId da página.
page_idId da página.
updatedtrue quando foi salvo.
Configurações de atraso salvas.
BuilderSummary
idId da página.
page_idId da página.
Resumo do construtor, com a árvore se include_tree for true.
BuilderNode
idId do nó.
page_idId da página.
node_idId do nó.
pathLocal do nó na árvore.
summaryResumo curto quando o construtor devolve.
O objeto do nó.
BuilderNodeFields
page_idId da página.
node_idId do nó.
Deve incluir misc, style ou ambos.
node_typeTipo de nó opcional.
BuilderNodeUpdate
idId do nó.
page_idId da página.
node_idId do nó.
updatedtrue quando foi salvo.
pathCaminho do nó.
BuilderNodeReplace
page_idId da página.
node_idId do nó a substituir.
Nó completo de substituição. Um string JSON também é aceito.
BuilderNodeReplaceResult
idId do nó.
page_idId da página.
node_idId do nó.
updatedtrue quando foi substituído.
pathCaminho do nó.
builder_warningsTexto JSON de avisos.
ContentMap
idId da página.
page_idId da página.
page_nameNome da página.
field_countQuantidade de campos editáveis.
variable_countQuantidade de variáveis.
variablesTexto JSON dos nomes das variáveis.
fieldsTexto JSON dos campos editáveis.
ready_for_variable_replacementtrue quando a página ainda tem variáveis.
Template
idId do modelo.
nameNome.
template_nameIgual a name.
categoryCategoria.
typeTipo, normalmente page.
descriptionDescrição.
preview_urlURL de pré-visualização.
image_urlURL da miniatura.
Quiz
idId do quiz (qid).
nameNome de exibição, com o nome da página quando conhecido.
quiz_nameNome do quiz.
page_idPágina que hospeda o quiz.
page_nameNome da página.
site_idId do site.
project_idId do projeto.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
QuizPage
idId da página.
quiz_idIgual a id na criação.
is_quizSempre true.
nameNome.
page_nameNome.
project_idId do projeto.
site_idId do site.
edit_urlURL do construtor.
QuizCreate
nameNome da página de quiz.
project_idId do projeto.
site_idId do site.
Funnel
idId do funil.
nameNome.
site_idId do site.
project_idId do projeto.
statusStatus.
Ids de página ou passos salvos no funil.
page_idsIds separados por vírgula quando pages é um array de ids.
Passos quando o funil os guarda.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
FunnelPage
pageIdId de uma página existente.
urlURL externa, quando não há pageId.
pageTypeTipo do passo, como presell, sales ou thankyou.
FunnelCreate
nameNome do funil.
project_idId do projeto.
Passos. Cada um precisa de pageId ou url.
Video
idId do vídeo.
video_idIgual a id.
nameNome.
titleTítulo do player.
statusStatus de codificação ou reprodução.
durationDuração em segundos quando o player a devolve.
thumbnail_urlURL da miniatura.
project_idId do projeto.
created_atData de criação.
updated_atData de atualização.
VideoUpdate
video_idId do vídeo.
nameNome na biblioteca.
titleTítulo do player.
languageIdioma do player.
project_idId do projeto.
primary_colorCor de destaque do player.
controlsMostrar controles.
autoplayIniciar a reprodução automaticamente.
mutedIniciar sem som.
loopRepetir a reprodução.
Product
idId do produto.
nameNome.
typesimple ou bundle.
skuSKU.
descriptionDescrição.
imageURL da imagem.
show_full_productMostrar o bloco completo do produto.
pricePreço.
compare_pricePreço de comparação.
ratingRótulo de avaliação.
rating_countRótulo da quantidade de avaliações.
project_idId do projeto.
cta_textTexto do botão.
cta_urlURL do botão.
cta_targetAbrir a URL em uma nova aba.
use_single_cta_linkUsar um único link de chamada.
bundle_discountDesconto do bundle.
bundle_item_countQuantidade de itens do bundle.
tiers_enabledOs níveis de quantidade estão ativos.
subscription_enabledA opção de assinatura está ativa.
created_atTimestamp ISO-8601.
updated_atTimestamp ISO-8601.
ProductWrite
nameNome.
typePadrão simple.
project_idId do projeto.
skuSKU.
descriptionDescrição.
imageURL da imagem.
pricePreço.
compare_pricePreço de comparação.
cta_textTexto do botão.
cta_urlURL do botão.
show_full_productMostrar o bloco completo.
cta_targetAbrir a URL em uma nova aba.
use_single_cta_linkUsar um único link.
ratingRótulo de avaliação. Padrão 4.9 se enviado vazio.
rating_countRótulo da quantidade.
trust_badges_jsonArray de rótulos, ou um string JSON.
variants_jsonArray de { id, name, image }, ou um string JSON.
tiers_enabledAtivar níveis de quantidade.
tiers_jsonObjetos de nível, ou um string JSON.
bundle_items_jsonObrigatório quando type é bundle.
bundle_discountDesconto do bundle.
subscription_jsonObjeto com enabled, discountPercent e benefits.
ProductUpdate
product_idId do produto.
nameNovo nome.
typeskuSKU.
descriptionDescrição.
imageURL da imagem.
pricePreço.
compare_pricePreço de comparação.
project_idId do projeto.
cta_textTexto do botão.
cta_urlURL do botão.
show_full_productMostrar o bloco completo.
cta_targetAbrir em uma nova aba.
use_single_cta_linkUsar um único link.
ratingRótulo de avaliação.
rating_countRótulo da quantidade.
trust_badges_jsonRótulos.
variants_jsonObjetos de variante.
tiers_enabledAtivar níveis.
tiers_jsonObjetos de nível.
bundle_items_jsonItens do bundle.
bundle_discountDesconto.
subscription_jsonConfigurações de assinatura.
Lead
idId do lead.
lead_idIgual a id.
typeform ou quiz.
nameNome.
first_nameNome.
last_nameSobrenome.
emailEmail.
phoneTelefone.
form_idId do formulário. Presente em leads de formulário.
form_nameNome do formulário.
quiz_idId do quiz. Presente em leads de quiz.
quiz_nameNome do quiz.
page_idId da página.
page_urlURL da página.
project_idId do projeto.
site_idId do site.
abandonedtrue quando um lead de formulário foi abandonado.
is_completedPresente em leads de quiz.
Campos brutos do formulário.
Respostas brutas do quiz.
created_atTimestamp ISO-8601.
Analytics
pagesQuantidade de páginas.
sitesQuantidade de sites.
funnelsQuantidade de funis.
productsQuantidade de produtos.
projectsQuantidade de projetos.
form_leadsQuantidade de leads de formulário.
quiz_leadsQuantidade de leads de quiz.
HookCreate
target_urlURL HTTPS pública que recebe o evento.
event_typeEvento a assinar.
Objeto de filtro opcional salvo com a assinatura.