Sign inStart free trial

← All action domains

Snapshots

20 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.

Finish setup

snapshots.checklistreadadmin only

The outstanding setup steps for an install — the phone numbers, domains and teammates a snapshot could not carry, plus anything that needs a look. Also reports what the install actually wrote: items created, items matched to what the account already had, and the number of detail rows written inside those items (pages, automation steps, knowledge items, invoice lines), broken down by kind so the figures can be checked against the snapshot.

Parameters

FieldTypeRequiredDescription
install_idstring (uuid)requiredThe install's id, from snapshots.list_installs.

Example

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

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

New snapshot

snapshots.createwriteadmin only

Creates a draft snapshot from a selection of this account's configuration. A draft is private and cannot be installed or shared until it is published.

Parameters

FieldTypeRequiredDescription
namestringrequiredWhat to call the snapshot.
taglinestringoptionalA one-line summary shown on the snapshot's card.
descriptionstringoptionalA longer explanation of what this snapshot sets up, for whoever installs it.
categorystringoptionalGrouping for the library, e.g. "lead-gen", "sales", "other".
selectionobject[]requiredWhat the snapshot contains. Anything these items depend on — a template an automation sends, a tag it applies — is pulled in automatically.
selection[].kindstringrequiredThe type of thing being included, e.g. "ivr_menu", "workflow", "funnel". Use snapshots.inventory to see what this account has.
selection[].idsarray of (string (uuid))requiredThe ids of the individual items of this type to include.

Example

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

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

Delete snapshot

snapshots.deletewriteconfirmowner only

Permanently deletes a snapshot, every published version of it, and the frozen copies of its recordings and images. Anything anyone already installed from it stays exactly where it is — an install is a copy, so this does not un-install anything.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

FieldTypeRequiredDescription
idstring (uuid)requiredThe snapshot's id.

Example

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

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

Snapshot details

snapshots.getread

One snapshot with every published version, including what each version contains and which outside servers its configuration would contact.

Parameters

FieldTypeRequiredDescription
idstring (uuid)requiredThe snapshot's id.

Example

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

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

Install snapshot

snapshots.installwriteconfirmadmin only

Writes a snapshot's configuration into an account — funnels, automations, templates, phone menus and settings. Everything arrives switched OFF: no automation runs, no message is sent, no page is published until a human turns it on. Nothing existing is overwritten or deleted. Reversible for 14 days.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

FieldTypeRequiredDescription
idstring (uuid)requiredThe snapshot's id.
target_org_idstring (uuid)optionalWhich account to install into. Defaults to the current one; may also be one of its client accounts.
version_idstring (uuid)optionalA specific version. Defaults to the latest.
slotsmap of string → stringoptionalValues for the things a snapshot cannot carry, keyed by slot id — a phone number id for each number it needs, and so on. Anything left unfilled becomes a setup task, and items that cannot exist without it are held back until it is supplied.

Example

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

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

What can go in a snapshot

snapshots.inventoryreadadmin only

Everything in this account that can be packaged into a snapshot, grouped by type. Reads configuration only — it never touches contacts, conversations, calls or any other customer data, because none of that can be put in a snapshot.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/snapshots.inventory \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'
Test with your API key

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

Snapshots

snapshots.listread

Lists the configuration snapshots this account owns, with their status and how many times each has been installed.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/snapshots.list \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'
Test with your API key

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

Who can install this

snapshots.list_grantsreadadmin only

Every account that has been granted or has bought the right to install a snapshot, and whether that access is still active.

Parameters

FieldTypeRequiredDescription
idstring (uuid)requiredThe snapshot's id.

Example

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

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

Install history

snapshots.list_installsreadadmin only

Every snapshot install into this account, with what it created, its status, and any setup steps still outstanding.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/snapshots.list_installs \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'
Test with your API key

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

Preview install

snapshots.preview_installreadadmin only

Dry-runs an install and reports exactly what would be created, what would be reused because a name already matches, which outside servers the configuration would contact, and what setup it still needs. Changes absolutely nothing.

Parameters

FieldTypeRequiredDescription
idstring (uuid)requiredThe snapshot's id.
target_org_idstring (uuid)optionalWhich account to preview installing into. Defaults to the current one; may also be one of its client accounts.
version_idstring (uuid)optionalA specific version. Defaults to the latest.

Example

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

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

Publish version

snapshots.publish_versionwriteconfirmadmin only

Freezes the current selection as a new, permanent version and copies every recording and image it uses into the snapshot. From now on anyone holding a share link or licence installs this version. Published versions can never be edited — publish again to ship a change.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

FieldTypeRequiredDescription
idstring (uuid)requiredThe snapshot's id.
changelogstringoptionalWhat changed since the previous version, shown to people who install it.

Example

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

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

Push to client accounts

snapshots.push_to_subaccountswriteconfirmowner only

Installs a snapshot into several client accounts at once. Each account is installed independently, so one failing does not stop the others. As with any install, everything arrives switched off and nothing existing is overwritten.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

FieldTypeRequiredDescription
idstring (uuid)requiredThe snapshot's id.
target_org_idsarray of (string (uuid))requiredThe client accounts to install into. Each must be a client account of this account.
version_idstring (uuid)optionalA specific version. Defaults to the latest.

Example

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

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

Fill a setup step

snapshots.resolve_slotwriteconfirmadmin only

Supplies one of the things a snapshot could not carry — typically a phone number id. The value is written everywhere the snapshot used it, including inside phone menus and automation steps, and anything that was held back waiting on it is created at that point.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

FieldTypeRequiredDescription
install_idstring (uuid)requiredThe install's id.
slot_keystringrequiredWhich setup step, e.g. "slot_1" — from snapshots.checklist.
valuestringrequiredThe id of the thing to use: a phone number id, a domain id, or a user id. It must belong to this account.

Example

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

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

Revoke access

snapshots.revoke_grantwriteconfirmowner only

Stops an account installing this snapshot again. It does NOT remove anything they have already installed — that is their own configuration now, and there is no remote kill switch.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

FieldTypeRequiredDescription
grant_idstring (uuid)requiredThe licence's id, from snapshots.list_grants.
reasonstringoptionalWhy, recorded on the licence.

Example

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

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

Snapshot item types

snapshots.typesread

The kinds of configuration a snapshot can carry, with the label and category of each. Useful for building a selection before calling snapshots.create.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/snapshots.types \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'
Test with your API key

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

Undo install

snapshots.undo_installwriteconfirmowner only

DELETES everything a snapshot install created in this account and restores anything it replaced. Items you have since attached real data to — a funnel that has taken orders, an invoice that has been paid — are kept rather than deleted. Only available for 14 days after the install.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

FieldTypeRequiredDescription
install_idstring (uuid)requiredThe install to reverse.

Example

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

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

Edit snapshot

snapshots.updatewriteadmin only

Renames a snapshot or changes what its next version will contain. Versions already published are frozen and are not affected.

Parameters

FieldTypeRequiredDescription
idstring (uuid)requiredThe snapshot's id.
namestringoptionalA new name.
taglinestringoptionalA new one-line summary.
descriptionstringoptionalA new description.
categorystringoptionalA new category.
selectionobject[]optionalReplaces what the next published version will contain. Published versions are unaffected.
selection[].kindstringrequiredThe type of thing being included, e.g. "ivr_menu", "workflow", "funnel". Use snapshots.inventory to see what this account has.
selection[].idsarray of (string (uuid))requiredThe ids of the individual items of this type to include.

Example

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

Over MCP the same operation is the tool snapshots_update 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=snapshots — same operations, with full JSON Schemas. Authentication, errors and rate limits are covered in the API documentation home.