Schemas

Download schema

Error

error

string · required

Código estable, como invalid_request o page_not_found.

message

string · required

Explicación legible.

Deleted

success

boolean

true cuando la eliminación tuvo éxito.

id

string

Id del registro eliminado.

deleted

boolean

true cuando el registro se eliminó.

Account

id

string

Id de la cuenta.

email

string | null

Email de la cuenta.

name

string

Nombre visible.

plan

Nombre del plan cuando existe.

workspace_id

string

El mismo valor que id.

Project

id

string

Id del proyecto.

name

string

Nombre.

description

string | null

Descripción.

context

string | null

Brief de marca. Presente al crear y actualizar.

active

boolean

false cuando el proyecto está inactivo.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo ISO-8601.

ProjectCreate

name

string · required

Nombre del proyecto.

Example: Spring campaign

description

string · minLength: 50 · required

Al menos 50 caracteres.

Example: Campaign assets for the spring launch across offers and traffic sources.

context

string · minLength: 200 · required

Al menos 200 caracteres sobre la marca y la 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

Nuevo nombre.

description

string

Nueva descripción.

context

string

Nuevo brief.

Site

id

string

Id del sitio.

name

string

Nombre visible, a menudo el dominio.

site_name

string | null

Nombre guardado en el sitio.

domain

string | null

Dominio público.

custom_domain

string | null

Dominio propio, si está conectado.

atomic_domain

string | null

Dominio entregado por Atomicat.

project_id

string | null

Id del proyecto.

status

string | null

Estado del sitio cuando existe.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo ISO-8601.

SiteCreated

id

string

Id del sitio.

site_id

string

El mismo valor que id.

name

string | null

Nombre del sitio.

atomic_domain

string | null

Dominio de Atomicat.

url

string | null

URL pública.

project_id

string | null

Id del proyecto.

custom_domain_instructions

Instrucciones DNS del dominio propio, cuando se devuelven.

SiteCreate

name

string

Nombre del sitio.

description

string

Descripción.

project_id

string

Proyecto al que se une el sitio.

Page

id

string

Id de la página.

name

string

Nombre visible. Incluye el sitio entre paréntesis cuando la página está en un sitio.

page_name

string

Nombre sin el sufijo del sitio.

status

string

published o draft.

is_quiz

boolean

true cuando la página es un quiz.

project_id

string | null

Id del proyecto.

site_id

string | null

Id del sitio cuando la página está unida a un sitio.

site_name

string | null

Nombre del sitio.

domain

string | null

Dominio publicado.

slug

string | null

Ruta en el sitio. Vacío significa la raíz.

url

string | null

URL pública después de publicar.

edit_url

string

Enlace a la página en el constructor.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo ISO-8601.

published_at

string | null

Hora de publicación ISO-8601.

PageCreate

name

string · required

Nombre de la página.

project_id

string

Id del proyecto.

PageFromTemplate

template_id

string · required

Id de plantilla de GET /templates.

name

string

Nombre de la página nueva.

site_id

string

Sitio al que unirla, si aplica.

project_id

string

Id del proyecto.

PageDuplicate

page_id

string · required

Página a copiar.

new_name

string

Nombre de la copia.

PageDuplicateResult

id

string

Id de la página nueva.

name

string

Nombre nuevo.

page_name

string

Nombre nuevo.

source_page_id

string

Id de la página copiada.

edit_url

string

URL del constructor.

PageMetadata

page_id

string · required

Id de la página.

name

string

Nuevo nombre.

project_id

string

Nuevo id de proyecto.

tags

Arreglo de etiquetas, o texto separado por comas.

product_label

string

Etiqueta de producto. produkt se acepta como alias.

PageMetadataResult

id

string

Id de la página.

page_id

string

Id de la página.

updated

boolean

true cuando se guardó.

name

string | null

Nombre después de la actualización.

project_id

string | null

Id de proyecto después de la actualización.

tags

Etiquetas después de la actualización.

product_label

string | null

Etiqueta después de la actualización.

PageIdBody

page_id

string · required

Id de la página.

PageContentUpdate

page_id

string · required

Id de la página.

object · required

Mapa de claves de contenido a valores nuevos. También se acepta un string JSON.

PageContentResult

id

string

Id de la página.

page_id

string

Id de la página.

success

boolean

true cuando la solicitud terminó.

applied_count

number

Cantidad de campos actualizados.

changed_section_count

number

Cantidad de secciones reescritas.

missing_count

number

Cantidad de claves no encontradas.

applied

string

Texto JSON de las actualizaciones aplicadas.

missing

string

Texto JSON de las claves no aplicadas.

PageVariables

page_id

string · required

Id de la página.

object · required

Nombre del marcador al texto. También se acepta un string JSON.

PageVariablesResult

id

string

Id de la página.

page_id

string

Id de la página.

success

boolean

true cuando terminó.

replacement_count

number

Cantidad de reemplazos.

changed_section_count

number

Secciones reescritas.

replaced_variables

string

Texto JSON de las variables reemplazadas.

remaining_variables

string

Texto JSON de las variables que siguen en la página.

remaining_variable_count

number

Cantidad de variables restantes.

PageValidation

id

string

Id de la página.

page_id

string

Id de la página.

ready_to_publish

boolean

true cuando no hay problemas.

issue_count

number

Cantidad de problemas.

issues

string

Texto JSON de los problemas.

field_count

number

Cantidad de campos editables.

remaining_variable_count

number

Variables que siguen en la página.

remaining_variables

string

Texto JSON de las variables restantes.

PagePublish

page_id

string · required

Id de la página.

site_id

string · required

Sitio que hospedará la página.

slug

string

Ruta en el sitio. Omite o envía vacío para la raíz.

PagePublishResult

id

string

Id de la página.

page_id

string

Id de la página.

site_id

string

Id del sitio.

success

boolean

true cuando la publicación tuvo éxito.

url

string | null

URL pública.

domain

string | null

Dominio publicado.

slug

string

Ruta publicada.

revision_saved

boolean

true cuando se guardó una revisión.

revision_warning

string | null

Aviso si la revisión no se pudo guardar.

PageDelay

page_id

string · required

Id de la página.

time

number

Retraso en segundos.

sync_with_video

boolean

Mostrar en sincronía con un video.

scroll_into_view

boolean

Desplazar la sección a la vista.

video_node_id

string

Id del nodo de video.

PageDelayResult

id

string

Id de la página.

page_id

string

Id de la página.

updated

boolean

true cuando se guardó.

object

Ajustes de retraso guardados.

BuilderSummary

id

string

Id de la página.

page_id

string

Id de la página.

object

Resumen del constructor, con el árbol si include_tree es true.

BuilderNode

id

string

Id del nodo.

page_id

string

Id de la página.

node_id

string

Id del nodo.

path

string | null

Ubicación del nodo en el árbol.

summary

Resumen corto cuando el constructor lo devuelve.

object

El objeto del nodo.

BuilderNodeFields

page_id

string · required

Id de la página.

node_id

string · required

Id del nodo.

object · required

Debe incluir misc, style o ambos.

node_type

string

Tipo de nodo opcional.

BuilderNodeUpdate

id

string

Id del nodo.

page_id

string

Id de la página.

node_id

string

Id del nodo.

updated

boolean

true cuando se guardó.

path

string | null

Ruta del nodo.

BuilderNodeReplace

page_id

string · required

Id de la página.

node_id

string · required

Id del nodo a reemplazar.

object · required

Nodo completo de reemplazo. También se acepta un string JSON.

BuilderNodeReplaceResult

id

string

Id del nodo.

page_id

string

Id de la página.

node_id

string

Id del nodo.

updated

boolean

true cuando se reemplazó.

path

string | null

Ruta del nodo.

builder_warnings

string

Texto JSON de advertencias.

ContentMap

id

string | null

Id de la página.

page_id

string | null

Id de la página.

page_name

string | null

Nombre de la página.

field_count

number

Cantidad de campos editables.

variable_count

number

Cantidad de variables.

variables

string

Texto JSON de los nombres de variables.

fields

string

Texto JSON de los campos editables.

ready_for_variable_replacement

boolean

true cuando la página todavía tiene variables.

Template

id

string

Id de la plantilla.

name

string

Nombre.

template_name

string

Igual que name.

category

string | null

Categoría.

type

string

Tipo, normalmente page.

description

string | null

Descripción.

preview_url

string | null

URL de vista previa.

image_url

string | null

URL de la miniatura.

Quiz

id

string

Id del quiz (qid).

name

string

Nombre visible, con el nombre de la página si se conoce.

quiz_name

string

Nombre del quiz.

page_id

string | null

Página que hospeda el quiz.

page_name

string | null

Nombre de la página.

site_id

string | null

Id del sitio.

project_id

string | null

Id del proyecto.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo ISO-8601.

QuizPage

Una página de quiz recién creada. id es el id de la página. Los listados posteriores devuelven el qid, que puede ser distinto.

id

string

Id de la página.

quiz_id

string

Igual que id al crear.

is_quiz

boolean

Siempre true.

name

string

Nombre.

page_name

string

Nombre.

project_id

string | null

Id del proyecto.

site_id

string | null

Id del sitio.

edit_url

string

URL del constructor.

QuizCreate

name

string · required

Nombre de la página de quiz.

project_id

string

Id del proyecto.

site_id

string

Id del sitio.

Funnel

id

string

Id del embudo.

name

string

Nombre.

site_id

string | null

Id del sitio.

project_id

string | null

Id del proyecto.

status

string | null

Estado.

array

Ids de página o pasos guardados en el embudo.

page_ids

string

Ids separados por comas cuando pages es un arreglo de ids.

object[]

Pasos cuando el embudo los guarda.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo ISO-8601.

FunnelPage

pageId

string

Id de una página existente.

url

string

URL externa, cuando no hay pageId.

pageType

string

Tipo de paso, como presell, sales o thankyou.

FunnelCreate

name

string · required

Nombre del embudo.

project_id

string

Id del proyecto.

FunnelPage[]

Pasos. Cada uno necesita pageId o url.

FunnelUpdate

funnel_id

string · required

Id del embudo.

name

string

Nuevo nombre.

FunnelPage[]

Video

id

string | null

Id del video.

video_id

string | null

Igual que id.

name

string | null

Nombre.

title

string | null

Título del reproductor.

status

string | null

Estado de codificación o reproducción.

duration

Duración en segundos cuando el reproductor la devuelve.

thumbnail_url

string | null

URL de la miniatura.

project_id

string | null

Id del proyecto.

created_at

string | null

Fecha de creación.

updated_at

string | null

Fecha de actualización.

VideoUpdate

video_id

string · required

Id del video.

name

string

Nombre en la biblioteca.

title

string

Título del reproductor.

language

string

Idioma del reproductor.

project_id

string

Id del proyecto.

primary_color

string

Color de acento del reproductor.

controls

boolean

Mostrar controles.

autoplay

boolean

Iniciar reproducción automáticamente.

muted

boolean

Iniciar silenciado.

loop

boolean

Repetir la reproducción.

Product

id

string

Id del producto.

name

string

Nombre.

type

string

simple o bundle.

sku

string | null

SKU.

description

string | null

Descripción.

image

string | null

URL de la imagen.

show_full_product

boolean

Mostrar el bloque completo del producto.

price

number

Precio.

compare_price

number

Precio de comparación.

rating

string | null

Etiqueta de valoración.

rating_count

string | null

Etiqueta de cantidad de valoraciones.

project_id

string | null

Id del proyecto.

cta_text

string | null

Texto del botón.

cta_url

string | null

URL del botón.

cta_target

boolean

Abrir la URL en una pestaña nueva.

use_single_cta_link

boolean

Usar un solo enlace de llamada a la acción.

bundle_discount

number

Descuento del bundle.

bundle_item_count

number

Cantidad de ítems del bundle.

tiers_enabled

boolean

Los niveles de cantidad están activos.

subscription_enabled

boolean

La opción de suscripción está activa.

created_at

string | null

Marca de tiempo ISO-8601.

updated_at

string | null

Marca de tiempo ISO-8601.

ProductWrite

name

string · required

Nombre.

type

string · enum

Predeterminado simple.

Enum values:

simple

bundle

project_id

string

Id del proyecto.

sku

string

SKU.

description

string

Descripción.

image

string

URL de la imagen.

price

number

Precio.

compare_price

number

Precio de comparación.

cta_text

string

Texto del botón.

cta_url

string

URL del botón.

show_full_product

boolean

Mostrar el bloque completo.

cta_target

boolean

Abrir la URL en una pestaña nueva.

use_single_cta_link

boolean

Usar un solo enlace.

rating

string

Etiqueta de valoración. Predeterminado 4.9 si se envía vacío.

rating_count

string

Etiqueta de cantidad.

trust_badges_json

Arreglo de etiquetas, o un string JSON.

variants_json

Arreglo de { id, name, image }, o un string JSON.

tiers_enabled

boolean

Activar niveles de cantidad.

tiers_json

Objetos de nivel, o un string JSON.

bundle_items_json

Obligatorio cuando type es bundle.

bundle_discount

number

Descuento del bundle.

subscription_json

Objeto con enabled, discountPercent y benefits.

ProductUpdate

product_id

string · required

Id del producto.

name

string

Nuevo nombre.

type

string · enum

Enum values:

simple

bundle

sku

string

SKU.

description

string

Descripción.

image

string

URL de la imagen.

price

number

Precio.

compare_price

number

Precio de comparación.

project_id

string

Id del proyecto.

cta_text

string

Texto del botón.

cta_url

string

URL del botón.

show_full_product

boolean

Mostrar el bloque completo.

cta_target

boolean

Abrir en una pestaña nueva.

use_single_cta_link

boolean

Usar un solo enlace.

rating

string

Etiqueta de valoración.

rating_count

string

Etiqueta de cantidad.

trust_badges_json

Etiquetas.

variants_json

Objetos de variante.

tiers_enabled

boolean

Activar niveles.

tiers_json

Objetos de nivel.

bundle_items_json

Ítems del bundle.

bundle_discount

number

Descuento.

subscription_json

Ajustes de suscripción.

Lead

id

string

Id del lead.

lead_id

string

Igual que id.

type

string

form o quiz.

name

string | null

Nombre.

first_name

string | null

Nombre.

last_name

string | null

Apellido.

email

string | null

Email.

phone

string | null

Teléfono.

form_id

string | null

Id del formulario. Presente en leads de formulario.

form_name

string | null

Nombre del formulario.

quiz_id

string | null

Id del quiz. Presente en leads de quiz.

quiz_name

string | null

Nombre del quiz.

page_id

string | null

Id de la página.

page_url

string | null

URL de la página.

project_id

string | null

Id del proyecto.

site_id

string | null

Id del sitio.

abandoned

boolean

true cuando un lead de formulario fue abandonado.

is_completed

boolean

Presente en leads de quiz.

object

Campos crudos del formulario.

object

Respuestas crudas del quiz.

created_at

string | null

Marca de tiempo ISO-8601.

Analytics

pages

number

Cantidad de páginas.

sites

number

Cantidad de sitios.

funnels

number

Cantidad de embudos.

products

number

Cantidad de productos.

projects

number

Cantidad de proyectos.

form_leads

number

Cantidad de leads de formulario.

quiz_leads

number

Cantidad de leads de quiz.

HookCreate

target_url

string · uri · required

URL HTTPS pública que recibe el evento.

event_type

string · enum · required

Evento al que suscribirse.

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 guardado con la suscripción.

HookSubscription

id

string

Id de la suscripción. Envíalo a DELETE /hooks/{subscriptionId}.

event_type

string

Evento suscrito.

active

boolean

true hasta que se desactiva.

created_at

string

Marca de tiempo ISO-8601.