Error
errorStable machine code, such as invalid_request or page_not_found.
messageHuman-readable explanation.
Deleted
successtrue when the delete succeeded.
idDeleted record id.
deletedtrue when the record was removed.
Account
idAccount id.
emailAccount email.
nameDisplay name.
planPlan name when the account has one.
workspace_idSame value as id.
Project
idProject id.
nameProject name.
descriptionProject description.
contextBrand brief. Present on create and update responses.
activefalse when the project is inactive.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
ProjectCreate
nameProject name.
descriptionAt least 50 characters.
contextAt least 200 characters describing the brand and offer.
ProjectUpdate
nameNew name.
descriptionNew description.
contextNew brand brief.
Site
idSite id.
nameDisplay name, often the domain.
site_nameName stored on the site.
domainPublic domain.
custom_domainCustom domain, when connected.
atomic_domainAtomicat-provided domain.
project_idProject id.
statusSite status when present.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
SiteCreated
idSite id.
site_idSame value as id.
nameSite name.
atomic_domainAtomicat domain.
urlPublic URL.
project_idProject id.
custom_domain_instructionsDNS instructions for a custom domain, when returned.
SiteCreate
nameSite name.
descriptionSite description.
project_idProject to attach the site to.
Page
idPage id.
nameDisplay name. Includes the site name in parentheses when the page is on a site.
page_namePage name without the site suffix.
statuspublished or draft.
is_quiztrue when the page is a quiz.
project_idProject id.
site_idSite id once the page is attached to a site.
site_nameSite name.
domainPublished domain.
slugPath on the site. Empty means the site root.
urlPublic URL after publish.
edit_urlLink to the page in the Atomicat builder.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
published_atISO-8601 publish time.
PageFromTemplate
template_idTemplate id from GET /templates.
nameName for the new page.
site_idSite to attach, if any.
project_idProject id.
PageDuplicateResult
idNew page id.
nameNew page name.
page_nameNew page name.
source_page_idId of the page that was copied.
edit_urlBuilder URL.
PageMetadata
page_idPage id.
nameNew name.
project_idNew project id.
tagsArray of tag names, or a comma-separated string.
product_labelProduct label shown on the page. produkt is accepted as an alias.
PageMetadataResult
idPage id.
page_idPage id.
updatedtrue when the update was saved.
nameName after the update.
project_idProject id after the update.
tagsTags after the update.
product_labelProduct label after the update.
PageContentUpdate
page_idPage id.
Map of content-field keys to new values. A JSON string is also accepted.
PageContentResult
idPage id.
page_idPage id.
successtrue when the request completed.
applied_countNumber of fields updated.
changed_section_countNumber of sections rewritten.
missing_countNumber of keys that were not found.
appliedJSON string of applied updates.
missingJSON string of keys that were not applied.
PageVariables
page_idPage id.
Placeholder name to replacement text. A JSON string is also accepted.
PageVariablesResult
idPage id.
page_idPage id.
successtrue when the request completed.
replacement_countNumber of replacements made.
changed_section_countSections rewritten.
replaced_variablesJSON string of variable names that were replaced.
remaining_variablesJSON string of variables still on the page.
remaining_variable_countCount of remaining variables.
PageValidation
idPage id.
page_idPage id.
ready_to_publishtrue when no issues were found.
issue_countNumber of issues.
issuesJSON string of issue objects.
field_countEditable field count.
remaining_variable_countVariables still on the page.
remaining_variablesJSON string of remaining variable names.
PagePublish
page_idPage id.
site_idSite that will host the page.
slugPath on the site. Omit or send an empty string for the site root.
PagePublishResult
idPage id.
page_idPage id.
site_idSite id.
successtrue when publish succeeded.
urlPublic URL.
domainPublished domain.
slugPublished path.
revision_savedtrue when a revision was stored.
revision_warningWarning when the revision could not be stored.
PageDelay
page_idPage id.
timeReveal delay in seconds.
sync_with_videoReveal in sync with a video.
scroll_into_viewScroll the delayed section into view.
video_node_idBuilder node id of the video to sync with.
PageDelayResult
idPage id.
page_idPage id.
updatedtrue when the delay was saved.
Saved delay settings.
BuilderSummary
idPage id.
page_idPage id.
Builder summary, including the section tree when include_tree is true.
BuilderNode
idNode id.
page_idPage id.
node_idNode id.
pathLocation of the node in the tree.
summaryShort node summary when the builder returns one.
The node object.
BuilderNodeFields
page_idPage id.
node_idNode id.
Must include misc, style, or both.
node_typeOptional node type hint.
BuilderNodeUpdate
idNode id.
page_idPage id.
node_idNode id.
updatedtrue when the node was saved.
pathNode path.
BuilderNodeReplace
page_idPage id.
node_idNode id to replace.
Complete replacement node. A JSON string is also accepted.
BuilderNodeReplaceResult
idNode id.
page_idPage id.
node_idNode id.
updatedtrue when the node was replaced.
pathNode path.
builder_warningsJSON string of builder warnings.
ContentMap
idPage id.
page_idPage id.
page_namePage name.
field_countNumber of editable fields.
variable_countNumber of template variables.
variablesJSON string of variable names.
fieldsJSON string of editable fields.
ready_for_variable_replacementtrue when the page still has variables.
Template
idTemplate id.
nameTemplate name.
template_nameSame as name.
categoryTemplate category.
typeTemplate type, usually page.
descriptionTemplate description.
preview_urlPreview URL.
image_urlThumbnail URL.
Quiz
idQuiz id (qid).
nameDisplay name, with the page name when known.
quiz_nameQuiz name.
page_idPage that hosts the quiz.
page_nameHost page name.
site_idSite id.
project_idProject id.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
QuizPage
idPage id.
quiz_idSame as id on create.
is_quizAlways true.
namePage name.
page_namePage name.
project_idProject id.
site_idSite id.
edit_urlBuilder URL.
QuizCreate
nameQuiz page name.
project_idProject id.
site_idSite id.
Funnel
idFunnel id.
nameFunnel name.
site_idSite id.
project_idProject id.
statusFunnel status.
Page ids or page step objects stored on the funnel.
page_idsComma-separated page ids when pages is an array of ids.
Step objects when the funnel stores them.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
FunnelPage
pageIdExisting page id.
urlExternal URL, used when there is no pageId.
pageTypeStep type, such as presell, sales, or thankyou.
FunnelCreate
nameFunnel name.
project_idProject id.
Steps. Each item needs pageId or url.
FunnelUpdate
funnel_idFunnel id.
nameNew name.
Video
idVideo id.
video_idSame as id.
nameVideo name.
titlePlayer title.
statusEncoding or playback status.
durationDuration in seconds when the player returns it.
thumbnail_urlThumbnail URL.
project_idProject id.
created_atCreated time.
updated_atUpdated time.
VideoUpdate
video_idVideo id.
nameLibrary name.
titlePlayer title.
languagePlayer language.
project_idProject id.
primary_colorPlayer accent color.
controlsShow player controls.
autoplayStart playback automatically.
mutedStart muted.
loopLoop playback.
Product
idProduct id.
nameProduct name.
typesimple or bundle.
skuSKU.
descriptionDescription.
imageImage URL.
show_full_productShow the full product block.
pricePrice.
compare_priceCompare-at price.
ratingRating label.
rating_countRating count label.
project_idProject id.
cta_textButton label.
cta_urlButton URL.
cta_targetOpen the button URL in a new tab.
use_single_cta_linkUse one call-to-action link.
bundle_discountBundle discount.
bundle_item_countNumber of bundle items.
tiers_enabledQuantity tiers are enabled.
subscription_enabledSubscription option is enabled.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
ProductWrite
nameProduct name.
typeDefaults to simple.
project_idProject id.
skuSKU.
descriptionDescription.
imageImage URL.
pricePrice.
compare_priceCompare-at price.
cta_textButton label.
cta_urlButton URL.
show_full_productShow the full product block.
cta_targetOpen the URL in a new tab.
use_single_cta_linkUse one call-to-action link.
ratingRating label. Defaults to 4.9 when sent empty.
rating_countRating count label.
trust_badges_jsonArray of badge labels, or a JSON string.
variants_jsonArray of { id, name, image }, or a JSON string.
tiers_enabledEnable quantity tiers.
tiers_jsonTier objects, or a JSON string.
bundle_items_jsonRequired when type is bundle.
bundle_discountBundle discount.
subscription_jsonObject with enabled, discountPercent, and benefits.
ProductUpdate
product_idProduct id.
nameNew name.
typeskuSKU.
descriptionDescription.
imageImage URL.
pricePrice.
compare_priceCompare-at price.
project_idProject id.
cta_textButton label.
cta_urlButton URL.
show_full_productShow the full product block.
cta_targetOpen the URL in a new tab.
use_single_cta_linkUse one call-to-action link.
ratingRating label.
rating_countRating count label.
trust_badges_jsonBadge labels.
variants_jsonVariant objects.
tiers_enabledEnable quantity tiers.
tiers_jsonTier objects.
bundle_items_jsonBundle items.
bundle_discountBundle discount.
subscription_jsonSubscription settings.
Lead
idLead id.
lead_idSame as id.
typeform or quiz.
nameContact name.
first_nameFirst name.
last_nameLast name.
emailEmail.
phonePhone.
form_idForm id. Present on form leads.
form_nameForm name.
quiz_idQuiz id. Present on quiz leads.
quiz_nameQuiz name.
page_idPage id.
page_urlPage URL.
project_idProject id.
site_idSite id.
abandonedtrue when a form lead was abandoned.
is_completedPresent on quiz leads.
Raw form fields.
Raw quiz answers.
created_atISO-8601 timestamp.
Analytics
pagesPage count.
sitesSite count.
funnelsFunnel count.
productsProduct count.
projectsProject count.
form_leadsForm lead count.
quiz_leadsQuiz lead count.
HookCreate
target_urlPublic HTTPS URL that receives the event.
event_typeEvent to subscribe to.
Optional filter object stored with the subscription.