Website API

Your website: its pages and menu, design, addresses, posts, FAQs and legal pages.

Module code site · 76 actions · 22 data models · 44 events. A key or token never does more here than the person behind it can; row-level security applies exactly as in the app. Scopes: site (everything), site:read (read only) or site:<capability>.

Resources

Lists take limit (up to 200), cursor, order (e.g. -created_at), fields and q; every other query parameter is a column filter: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

Actions

site.add_domain

Add an address — Claims a hostname for a site and issues the record that proves it is yours.

Needs site:manage · changes data

• REST alias: POST /api/v1/domains
• Canonical address: POST /api/v1/actions/site.add_domain

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.domain_added

What it writes: domain (insert) — Registers it pending, with a verification token

curl -X POST https://app.getera.io/api/v1/domains/actions/add_domain \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"siteId":"SITE_ID","host":"Hostname"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.domain_added"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.domains.create({
  siteId: "SITE_ID",
  host: "Hostname"
})

era domains create \
  --site-id "SITE_ID" \
  --host "Hostname"

{
  "name": "era__site__add_domain",
  "arguments": {
    "siteId": "SITE_ID",
    "host": "Hostname"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 site_not_found, invalid_host, platform_domain, host_taken · 429 slow down

site.add_page_block

Add a page section — Adds one renderer block to a page in the draft theme.

Needs site:write · changes data

• Canonical address: POST /api/v1/actions/site.add_page_block

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.blocks_changed

What it writes: theme (update) — Adds one block to config.pageBlocks

curl -X POST https://app.getera.io/api/v1/themes/THEME_ID/actions/add_page_block \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"pageId":"PAGE_ID","blockId":"Section","type":"Block type","data":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.blocks_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.themes.addPageBlock("THEME_ID", {
  pageId: "PAGE_ID",
  blockId: "Section",
  type: "Block type",
  data: {}
})

era themes add_page_block THEME_ID --data '{"pageId":"PAGE_ID","blockId":"Section","type":"Block type","data":{}}'

{
  "name": "era__site__add_page_block",
  "arguments": {
    "themeId": "THEME_ID",
    "pageId": "PAGE_ID",
    "blockId": "Section",
    "type": "Block type",
    "data": {}
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 theme_not_found, theme_is_published, archived, page_not_found, invalid_blocks, duplicate_block_id · 429 slow down

site.add_section

Add a section to a page — A new section on a page of the site’s draft — visitors see it after publishing.

Needs site:write · changes data

• Canonical address: POST /api/v1/actions/site.add_section

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.blocks_changed, site.theme_draft_created

What it writes: theme (update) — Changes one page of the site’s draft (a draft is forked from the live theme when there is none); theme_snapshot (insert) — Keeps an automatic checkpoint of the draft before the change; theme (insert) — Starts a draft when the site has none

curl -X POST https://app.getera.io/api/v1/theme_snapshots/actions/add_section \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"type":"Kind of section"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.blocks_changed",
    "site.theme_draft_created"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.themeSnapshots.addSection({
  type: "Kind of section"
})

era theme_snapshots add_section \
  --type "Kind of section"

{
  "name": "era__site__add_section",
  "arguments": {
    "type": "Kind of section"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 site_not_found, page_not_found, unknown_block_type, block_not_found, invalid_blocks · 429 slow down

site.assign_images

Assign image — Sets the same cover image on the selected content, preserving all other fields.

Needs site:write · changes data

• Canonical address: POST /api/v1/actions/site.assign_images

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.post_saved, site.news_saved, site.reference_saved

What it writes: blog_post (update) — Sets the cover image without replacing content; news (update) — Sets the cover image without replacing content; client_reference (update) — Sets the cover image without replacing content

curl -X POST https://app.getera.io/api/v1/blog_posts/actions/assign_images \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"ids":{},"fileId":"FILE_ID","contentType":"blog"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.post_saved",
    "site.news_saved",
    "site.reference_saved"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.blogPosts.assignImages({
  ids: {},
  fileId: "FILE_ID",
  contentType: "blog"
})

era blog_posts assign_images --data '{"ids":{},"fileId":"FILE_ID","contentType":"blog"}'

{
  "name": "era__site__assign_images",
  "arguments": {
    "ids": {},
    "fileId": "FILE_ID",
    "contentType": "blog"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 no_items, file_not_found, image_required, not_found · 429 slow down

site.cancel_scheduled_content

Cancel scheduled publication — Keeps the article as a draft and cancels its pending job.

Needs site:write · removes or cannot be undone

• Canonical address: POST /api/v1/actions/site.cancel_scheduled_content

Input

Preconditions

The action is refused with 409 and one of these codes:

What it writes: blog_post (update) — Clears a post schedule; news (update) — Clears a news schedule

curl -X POST https://app.getera.io/api/v1/blog_posts/actions/cancel_scheduled_content \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"id":"ID_ID","kind":"post"}'

{
  "ok": true,
  "result": "…",
  "events": []
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.blogPosts.cancelScheduledContent({
  id: "ID_ID",
  kind: "post"
})

era blog_posts cancel_scheduled_content \
  --id "ID_ID" \
  --kind "post"

{
  "name": "era__site__cancel_scheduled_content",
  "arguments": {
    "id": "ID_ID",
    "kind": "post"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_scheduled · 429 slow down

site.cancel_theme_schedule

Cancel a scheduled theme — Keeps the draft as a draft and cancels its pending publication.

Needs site:manage · removes or cannot be undone

• Canonical address: POST /api/v1/actions/site.cancel_theme_schedule

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.theme_scheduled

What it writes: theme (update) — Clears the schedule

curl -X POST https://app.getera.io/api/v1/themes/THEME_ID/actions/cancel_theme_schedule \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.theme_scheduled"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.themes.cancelThemeSchedule("THEME_ID")

era themes cancel_theme_schedule THEME_ID

{
  "name": "era__site__cancel_theme_schedule",
  "arguments": {
    "themeId": "THEME_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_scheduled · 429 slow down

site.create_page

Add a page — A new page on the site, as a draft and out of the menu.

Needs site:write · changes data

• Canonical address: POST /api/v1/actions/site.create_page

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.page_created

What it writes: page (insert) — Creates the page as a draft

curl -X POST https://app.getera.io/api/v1/pages/PAGE_ID/actions/create_page \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"siteId":"SITE_ID","title":"Title"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.page_created"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.pages.createPage("PAGE_ID", {
  siteId: "SITE_ID",
  title: "Title"
})

era pages create_page PAGE_ID \
  --site-id "SITE_ID" \
  --title "Title"

{
  "name": "era__site__create_page",
  "arguments": {
    "parentId": "PAGE_ID",
    "siteId": "SITE_ID",
    "title": "Title"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 site_not_found, slug_taken, parent_not_found · 429 slow down

site.create_site

Create a site — A public face for this workspace, with the platform address it answers on.

Needs site:manage · changes data

• REST alias: POST /api/v1/sites
• Canonical address: POST /api/v1/actions/site.create_site

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.created

What it writes: site (insert) — Creates the site, unpublished; domain (insert) — Issues its platform address, already verified

curl -X POST https://app.getera.io/api/v1/sites/actions/create_site \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Name"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.created"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.sites.create({
  name: "Name"
})

era sites create \
  --name "Name"

{
  "name": "era__site__create_site",
  "arguments": {
    "name": "Name"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 invalid_slug, slug_taken, host_taken · 429 slow down

site.create_theme_draft

Start a draft — A copy of the live theme to work in, so visitors do not watch you edit.

Needs site:manage · changes data

• Canonical address: POST /api/v1/actions/site.create_theme_draft

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.theme_draft_created

What it writes: theme (insert) — Forks the live theme into a draft

curl -X POST https://app.getera.io/api/v1/themes/actions/create_theme_draft \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"siteId":"SITE_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.theme_draft_created"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.themes.createThemeDraft({
  siteId: "SITE_ID"
})

era themes create_theme_draft \
  --site-id "SITE_ID"

{
  "name": "era__site__create_theme_draft",
  "arguments": {
    "siteId": "SITE_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 site_not_found, draft_exists · 429 slow down

site.define_content

Declare the content a site uses — Creates or updates the editable content entries (texts, images, links, opening hours, lists) a code site binds to. Values the owner already changed are kept unless overwrite is set.

Needs site:manage · changes data

• Canonical address: POST /api/v1/actions/site.define_content

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.content_changed

What it writes: site_content (insert) — New entries; site_content (update) — Label, kind and section of existing entries; empty languages filled in

curl -X POST https://app.getera.io/api/v1/site_contents/actions/define_content \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"siteId":"SITE_ID","entries":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.content_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.siteContents.defineContent({
  siteId: "SITE_ID",
  entries: {}
})

era site_contents define_content --data '{"siteId":"SITE_ID","entries":{}}'

{
  "name": "era__site__define_content",
  "arguments": {
    "siteId": "SITE_ID",
    "entries": {}
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 site_not_found, invalid_content · 429 slow down

site.delete_blog_taxonomy

Delete blog category, tag or author — Removes unused blog vocabulary. Posts must be moved first.

Needs site:manage · removes or cannot be undone · asks a person to confirm when Era runs it

• Canonical address: POST /api/v1/actions/site.delete_blog_taxonomy

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.blog_taxonomy_changed

What it writes: blog_category (delete) — Deletes an unused category; blog_tag (delete) — Deletes an unused tag; blog_author (delete) — Deletes an unused author

curl -X POST https://app.getera.io/api/v1/blog_categories/actions/delete_blog_taxonomy \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"id":"ID_ID","kind":"category"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.blog_taxonomy_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.blogCategories.deleteBlogTaxonomy({
  id: "ID_ID",
  kind: "category"
})

era blog_categories delete_blog_taxonomy \
  --id "ID_ID" \
  --kind "category"

{
  "name": "era__site__delete_blog_taxonomy",
  "arguments": {
    "id": "ID_ID",
    "kind": "category"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 category_not_found, tag_not_found, author_not_found, blog_category_in_use, blog_tag_in_use, blog_author_in_use · 429 slow down

site.delete_content

Remove a content entry — Removes an entry the site no longer uses.

Needs site:manage · removes or cannot be undone · asks a person to confirm when Era runs it

• Canonical address: POST /api/v1/actions/site.delete_content

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.content_changed

What it writes: site_content (delete) — The entry

curl -X POST https://app.getera.io/api/v1/site_contents/actions/delete_content \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"siteId":"SITE_ID","key":"Entry"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.content_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.siteContents.deleteContent({
  siteId: "SITE_ID",
  key: "Entry"
})

era site_contents delete_content \
  --site-id "SITE_ID" \
  --key "Entry"

{
  "name": "era__site__delete_content",
  "arguments": {
    "siteId": "SITE_ID",
    "key": "Entry"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 site_not_found, content_not_found · 429 slow down

site.delete_faq_category

Remove an FAQ group — Removes the group and leaves its questions ungrouped.

Needs site:delete · removes or cannot be undone

• REST alias: DELETE /api/v1/faq_categories/{id}
• Canonical address: POST /api/v1/actions/site.delete_faq_category

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.faq_changed

What it writes: faq_category (delete) — Removes the group; faq_item (update) — Leaves its questions ungrouped through the foreign key

curl -X POST https://app.getera.io/api/v1/faq_categories/FAQ_CATEGORY_ID/actions/delete_faq_category \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.faq_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.faqCategories.deleteFaqCategory("FAQ_CATEGORY_ID")

era faq_categories delete_faq_category FAQ_CATEGORY_ID

{
  "name": "era__site__delete_faq_category",
  "arguments": {
    "id": "FAQ_CATEGORY_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:delete · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 category_not_found · 429 slow down

site.delete_faq_item

Remove an FAQ question — Removes one question from the site accordion.

Needs site:delete · removes or cannot be undone

• REST alias: DELETE /api/v1/faq_items/{id}
• Canonical address: POST /api/v1/actions/site.delete_faq_item

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.faq_changed

What it writes: faq_item (delete) — Removes the question

curl -X POST https://app.getera.io/api/v1/faq_items/FAQ_ITEM_ID/actions/delete_faq_item \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.faq_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.faqItems.deleteFaqItem("FAQ_ITEM_ID")

era faq_items delete_faq_item FAQ_ITEM_ID

{
  "name": "era__site__delete_faq_item",
  "arguments": {
    "id": "FAQ_ITEM_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:delete · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 faq_item_not_found · 429 slow down

site.delete_page

Delete a page — Gone for good. Pages that came with the site can only be archived.

Needs site:delete · removes or cannot be undone · asks a person to confirm when Era runs it

• REST alias: DELETE /api/v1/pages/{id}
• Canonical address: POST /api/v1/actions/site.delete_page

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.page_deleted

What it writes: page (delete) — Removes the page

curl -X POST https://app.getera.io/api/v1/pages/PAGE_ID/actions/delete_page \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.page_deleted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.pages.deletePage("PAGE_ID")

era pages delete_page PAGE_ID

{
  "name": "era__site__delete_page",
  "arguments": {
    "id": "PAGE_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:delete · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 page_not_found, page_is_default, homepage_must_stay_published, has_children · 429 slow down

site.delete_redirect

Remove a redirect — The old address starts returning “not found” again.

Needs site:manage · removes or cannot be undone · asks a person to confirm when Era runs it

• Canonical address: POST /api/v1/actions/site.delete_redirect

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.redirect_changed

What it writes: page_redirect (delete) — Removes the redirect

curl -X POST https://app.getera.io/api/v1/page_redirects/PAGE_REDIRECT_ID/actions/delete_redirect \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.redirect_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.pageRedirects.deleteRedirect("PAGE_REDIRECT_ID")

era page_redirects delete_redirect PAGE_REDIRECT_ID

{
  "name": "era__site__delete_redirect",
  "arguments": {
    "id": "PAGE_REDIRECT_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 redirect_not_found · 429 slow down

site.delete_reference

Remove a reference — Removes a client project and its testimonial from the site.

Needs site:delete · removes or cannot be undone

• Canonical address: POST /api/v1/actions/site.delete_reference

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.reference_deleted

What it writes: client_reference (delete) — Removes the reference

curl -X POST https://app.getera.io/api/v1/client_references/CLIENT_REFERENCE_ID/actions/delete_reference \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.reference_deleted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.clientReferences.deleteReference("CLIENT_REFERENCE_ID")

era client_references delete_reference CLIENT_REFERENCE_ID

{
  "name": "era__site__delete_reference",
  "arguments": {
    "id": "CLIENT_REFERENCE_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:delete · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 reference_not_found · 429 slow down

site.edit_page_block

Edit a page section — Replaces the data, type or visibility of one renderer block.

Needs site:write · changes data

• Canonical address: POST /api/v1/actions/site.edit_page_block

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.blocks_changed

What it writes: theme (update) — Edits one block in config.pageBlocks

curl -X POST https://app.getera.io/api/v1/themes/THEME_ID/actions/edit_page_block \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"pageId":"PAGE_ID","blockId":"Section"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.blocks_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.themes.editPageBlock("THEME_ID", {
  pageId: "PAGE_ID",
  blockId: "Section"
})

era themes edit_page_block THEME_ID \
  --page-id "PAGE_ID" \
  --block-id "Section"

{
  "name": "era__site__edit_page_block",
  "arguments": {
    "themeId": "THEME_ID",
    "pageId": "PAGE_ID",
    "blockId": "Section"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 theme_not_found, theme_is_published, archived, page_not_found, block_not_found, invalid_blocks, duplicate_block_id · 429 slow down

site.edit_section

Edit a section — Words, an image, settings or visibility of one section, in the site’s draft.

Needs site:write · changes data

• Canonical address: POST /api/v1/actions/site.edit_section

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.blocks_changed, site.theme_draft_created

What it writes: theme (update) — Changes one page of the site’s draft (a draft is forked from the live theme when there is none); theme_snapshot (insert) — Keeps an automatic checkpoint of the draft before the change; theme (insert) — Starts a draft when the site has none

curl -X POST https://app.getera.io/api/v1/theme_snapshots/actions/edit_section \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"section":"Section"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.blocks_changed",
    "site.theme_draft_created"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.themeSnapshots.editSection({
  section: "Section"
})

era theme_snapshots edit_section \
  --section "Section"

{
  "name": "era__site__edit_section",
  "arguments": {
    "section": "Section"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 site_not_found, page_not_found, block_not_found, invalid_path, invalid_image, invalid_device, invalid_blocks, nothing_to_change · 429 slow down

site.finish_deploy

Record a deploy result — Machine step: marks a version live (the previous one superseded) or failed, with its log.

Needs site:manage · reaches outside (sends, publishes or charges)

• Canonical address: POST /api/v1/actions/site.finish_deploy

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.deployed, site.deploy_failed

What it writes: site_deploy (update) — Live or failed; the previous live version becomes superseded

curl -X POST https://app.getera.io/api/v1/site_deploys/SITE_DEPLOY_ID/actions/finish_deploy \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"ok":true}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.deployed",
    "site.deploy_failed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.siteDeploys.finishDeploy("SITE_DEPLOY_ID", {
  ok: true
})

era site_deploys finish_deploy SITE_DEPLOY_ID \
  --ok true

{
  "name": "era__site__finish_deploy",
  "arguments": {
    "id": "SITE_DEPLOY_ID",
    "ok": true
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 deploy_not_found, not_uploading · 429 slow down

site.import_theme

Import a code site’s theme — Registers the sections and settings a code site declares in era.theme.json, so the owner edits them in Era’s theme editor. Values the owner already changed are kept; new settings get their defaults.

Needs site:manage · removes or cannot be undone

• Canonical address: POST /api/v1/actions/site.import_theme

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.theme_imported, site.content_changed

What it writes: site_code_theme (upsert) — The manifest, one per site, with a version counter; site_content (upsert) — One entry per setting; existing values are kept; site_content (delete) — Settings no longer declared, only with prune

curl -X POST https://app.getera.io/api/v1/site_code_themes/actions/import_theme \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"siteId":"SITE_ID","manifest":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.theme_imported",
    "site.content_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.siteCodeThemes.importTheme({
  siteId: "SITE_ID",
  manifest: {}
})

era site_code_themes import_theme --data '{"siteId":"SITE_ID","manifest":{}}'

{
  "name": "era__site__import_theme",
  "arguments": {
    "siteId": "SITE_ID",
    "manifest": {}
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 site_not_found, invalid_theme, invalid_content · 429 slow down

site.mark_submission

Mark a message — Read, replied, archived or spam — the states the product never had.

Needs site:write · changes data

• Canonical address: POST /api/v1/actions/site.mark_submission

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.submission_marked

What it writes: contact_submission (update) — Changes the message state

curl -X POST https://app.getera.io/api/v1/contact_submissions/CONTACT_SUBMISSION_ID/actions/mark_submission \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"status":"new"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.submission_marked"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.contactSubmissions.markSubmission("CONTACT_SUBMISSION_ID", {
  status: "new"
})

era contact_submissions mark_submission CONTACT_SUBMISSION_ID \
  --status "new"

{
  "name": "era__site__mark_submission",
  "arguments": {
    "id": "CONTACT_SUBMISSION_ID",
    "status": "new"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 submission_not_found, no_change · 429 slow down

site.move_page

Move a page — Puts a page under another one, refusing anything circular.

Needs site:write · changes data

• Canonical address: POST /api/v1/actions/site.move_page

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.page_moved

What it writes: page (update) — Re-parents the page through tree_move

curl -X POST https://app.getera.io/api/v1/pages/PAGE_ID/actions/move_page \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"parentId":"PAGE_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.page_moved"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.pages.movePage("PAGE_ID", {
  parentId: "PAGE_ID"
})

era pages move_page PAGE_ID \
  --parent-id "PAGE_ID"

{
  "name": "era__site__move_page",
  "arguments": {
    "id": "PAGE_ID",
    "parentId": "PAGE_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 page_not_found, parent_not_found, cannot_parent_to_self, would_create_cycle · 429 slow down

site.move_page_block

Move a page section — Moves one renderer block to a new position on its page.

Needs site:write · changes data

• Canonical address: POST /api/v1/actions/site.move_page_block

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.blocks_changed

What it writes: theme (update) — Reorders one block in config.pageBlocks

curl -X POST https://app.getera.io/api/v1/themes/THEME_ID/actions/move_page_block \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"pageId":"PAGE_ID","blockId":"Section","toIndex":1}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.blocks_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.themes.movePageBlock("THEME_ID", {
  pageId: "PAGE_ID",
  blockId: "Section",
  toIndex: 1
})

era themes move_page_block THEME_ID \
  --page-id "PAGE_ID" \
  --block-id "Section" \
  --to-index 1

{
  "name": "era__site__move_page_block",
  "arguments": {
    "themeId": "THEME_ID",
    "pageId": "PAGE_ID",
    "blockId": "Section",
    "toIndex": 1
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 theme_not_found, theme_is_published, archived, page_not_found, block_not_found, invalid_blocks, duplicate_block_id · 429 slow down

site.move_section

Move a section — Puts a section at another place on its page, in the draft.

Needs site:write · changes data

• Canonical address: POST /api/v1/actions/site.move_section

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: site.blocks_changed, site.theme_draft_created

What it writes: theme (update) — Changes one page of the site’s draft (a draft is forked from the live theme when there is none); theme_snapshot (insert) — Keeps an automatic checkpoint of the draft before the change; theme (insert) — Starts a draft when the site has none

curl -X POST https://app.getera.io/api/v1/theme_snapshots/actions/move_section \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"section":"Section"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "site.blocks_changed",
    "site.theme_draft_created"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.themeSnapshots.moveSection({
  section: "Section"
})

era theme_snapshots move_section \
  --section "Section"

{
  "name": "era__site__move_section",
  "arguments": {
    "section": "Section"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold site:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 site_not_found, page_not_found, block_not_found, no_position, nothing_to_change · 429 slow down

site.publish

Take a site live — A flip, not a deploy — once something points at it.

Needs site:manage · reaches outside (sends, publishes or charges)

• Canonical address: POST /api/v1/actions/site.publish

Input