← All action domains

Shared sections

5 operations. Call each with POST https://app.chirply.io/api/v1/actions/<name> and a bearer token; the response is { "data": { "action", "summary", "result" } }. A read badge means the operation changes nothing; write requires the credential’s write scope.

Add linked section

shared_sections.addwrite

Append a linked copy of a shared native section to a website page's saved draft, preserving existing content and undo history. No public page changes until publish.

Parameters

FieldTypeRequiredDescription
page_idstring (uuid)requiredWebsite page whose native top-level sections are being managed.
expected_revisionstringrequiredRequired exact updated_at from funnel_pages.get for this page; stale drafts are rejected instead of overwriting another editor.
section_idstring (uuid)requiredShared library section from this same website.

Example

curl -X POST https://app.chirply.io/api/v1/actions/shared_sections.add \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "page_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "expected_revision": "example",
    "section_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'
Test with your API key

Over MCP the same operation is the tool shared_sections_add at https://app.chirply.io/api/mcp, same bearer token, same input.

Detach shared section

shared_sections.detachwrite

Remove the link from one shared section instance while preserving its native page content exactly. Future shared updates leave that independent instance alone; published pages are unchanged.

Parameters

FieldTypeRequiredDescription
page_idstring (uuid)requiredWebsite page whose native top-level sections are being managed.
expected_revisionstringrequiredRequired exact updated_at from funnel_pages.get for this page; stale drafts are rejected instead of overwriting another editor.
node_idstringrequiredPermanent props.id of the selected top-level native section in the saved page document.
section_idstring (uuid)requiredShared library section from this same website.

Example

curl -X POST https://app.chirply.io/api/v1/actions/shared_sections.detach \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "page_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "expected_revision": "example",
    "node_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "section_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'
Test with your API key

Over MCP the same operation is the tool shared_sections_detach at https://app.chirply.io/api/mcp, same bearer token, same input.

List shared sections

shared_sections.listread

List the website's native shared section library and this page's linked instances. Reads saved drafts and binding revisions; it changes nothing.

Parameters

FieldTypeRequiredDescription
page_idstring (uuid)requiredWebsite page whose native top-level sections are being managed.

Example

curl -X POST https://app.chirply.io/api/v1/actions/shared_sections.list \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "page_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'
Test with your API key

Over MCP the same operation is the tool shared_sections_list at https://app.chirply.io/api/mcp, same bearer token, same input.

Share selected section

shared_sections.sharewrite

Save a selected native top-level section to this website's shared library and link its source instance. It stays a fully editable native subtree; no live page changes until publish.

Parameters

FieldTypeRequiredDescription
page_idstring (uuid)requiredWebsite page whose native top-level sections are being managed.
expected_revisionstringrequiredRequired exact updated_at from funnel_pages.get for this page; stale drafts are rejected instead of overwriting another editor.
node_idstringrequiredPermanent props.id of the selected top-level native section in the saved page document.
namestringrequiredLibrary name, such as Site header or Newsletter footer.

Example

curl -X POST https://app.chirply.io/api/v1/actions/shared_sections.share \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "page_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "expected_revision": "example",
    "node_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "name": "Example"
  }'
Test with your API key

Over MCP the same operation is the tool shared_sections_share at https://app.chirply.io/api/mcp, same bearer token, same input.

Update linked pages

shared_sections.syncwrite

Copy the selected linked section into every linked draft page in one transaction. Reject the entire update when another linked instance has local edits or a page changed. Published snapshots stay unchanged until publish.

Parameters

FieldTypeRequiredDescription
page_idstring (uuid)requiredWebsite page whose native top-level sections are being managed.
expected_revisionstringrequiredRequired exact updated_at from funnel_pages.get for this page; stale drafts are rejected instead of overwriting another editor.
node_idstringrequiredPermanent props.id of the selected top-level native section in the saved page document.
section_idstring (uuid)requiredShared library section from this same website.

Example

curl -X POST https://app.chirply.io/api/v1/actions/shared_sections.sync \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "page_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "expected_revision": "example",
    "node_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "section_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'
Test with your API key

Over MCP the same operation is the tool shared_sections_sync at https://app.chirply.io/api/mcp, same bearer token, same input.

The machine-readable version of this page is GET https://app.chirply.io/api/v1/actions?domain=shared_sections — same operations, with full JSON Schemas. Authentication, errors and rate limits are covered in the API documentation home.