Apps

Move one installed Marketplace app to its newest published version. For hosted or external apps this immediately changes the app UI and declared event subscriptions running in the account; native apps acknowledge the version of their already-deployed feature. Existing permissions and access token remain unchanged.

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

Example

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

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

Submit payment for a paid app prepared with apps.start_purchase. On the first call, confirmation_token must come from the buyer's completed Stripe Payment Element; only then does this create and confirm a REAL-MONEY one-time charge or monthly subscription on the developer's Stripe account. If customer authentication is required, call again without the token after Stripe.js completes it. Installs the app only after Stripe verifies payment.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.complete_purchase \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "order_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

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

After paying on an agency's Stripe Checkout page (from apps.start_reseller_checkout), confirm that payment with the agency's Stripe and switch the app on in THIS account now, instead of waiting for the agency's Stripe webhook. Charges nothing and is safe to repeat — a payment already confirmed changes nothing, and a checkout that was not for this account, not paid, or taken in test mode is refused.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.confirm_reseller_checkout \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "session_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

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

Create a new app in this agency's developer account, as a private draft. Doesn't publish or list it — that happens later via apps.submit_for_review and platform review. Requires an agency (white-label or reseller) plan. Both hosting modes are live: 'external' loads your own HTTPS URL in a sandboxed iframe, 'hosted' serves a self-contained HTML document you publish through apps.publish_version. Paid apps are live too — apps.start_purchase and apps.complete_purchase take real money from buyers — so set pricing_kind, price_cents and currency to what you actually intend to charge.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.create \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "example",
    "name": "Example"
  }'

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

Read this FIRST. Returns the complete guide to building and publishing a marketplace app with your own AI agent: the hosted vs external model, the create → publish_version → submit_for_review → (admin review) → install flow, the manifest (pages/widgets/cards), the App SDK (chirply.call / chirply.data / chirply.context), the scope grammar, and a minimal worked hosted app. After reading it, use apps.create, apps.publish_version, and apps.submit_for_review.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.dev_guide \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

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

Start (or resume) Stripe Connect onboarding so your agency gets PAID for paid app installs. Returns a Stripe-hosted onboarding URL — open it, finish the steps, come back. Money from paid installs settles to this connected account (you're the merchant of record), minus the marketplace fee. Required before you can actually charge for an app.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.developer_connect \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

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

Check your agency's Stripe Connect payout account for paid app installs — whether it's connected, can accept charges, and can receive payouts.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.developer_connect_status \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

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

Check what this account has PAID for on one app, which is a different question from whether it is currently installed. Returns how it was bought (paid once, monthly, or yearly), whether the account may install it again without paying, when a subscription's paid-up period ends, and whether that subscription is already cancelling. Reads only — spends no money and changes no install. Use it before apps.install on a paid app: an account that already owns one reinstalls for free, so a purchase is not always needed.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.entitlement \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "slug": "example"
  }'

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

Fetch one of this agency's apps by id, with all of its fields.

Parameters

Example

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

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

Fetch one marketplace app's public listing detail by slug or id: its full description, screenshots, icon, pricing, category, requested scopes, developer name, and how many accounts have it installed. Returns publicly-listed apps, plus your own agency's apps before they're listed. This is the read behind the app's detail page. In a client account whose agency resells the app, the pricing is the AGENCY's and `agency_offer` says who sells it, at what price, whether it can be bought yet (the agency has connected its Stripe) and whether this account already owns it.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.get_listing \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "example",
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

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

Install an app into THIS account and issue it an access token with the scopes you grant. This gives third-party code ongoing API access to the account's data within those scopes — the token is shown once and can't be retrieved again. IT ALSO STARTS SENDING DATA OUT: if the app's manifest subscribes to events and you grant 'events:read', the install provisions those event subscriptions and returns a `webhook_secret`, after which this account POSTs the subscribed events (new contacts, inbound messages, won deals, paid invoices…) to the app developer's own server as they happen, until someone uninstalls. Grant the least it needs, and know where the data is going. Re-installing rotates the existing 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

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.install \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "grant_scopes": [
      "example"
    ]
  }'

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

Turn ON one of the platform's built-in (native) first-party apps for this account: Browser Agent ('browser-agent'), Directories ('directories'), Domain Leads ('domain-leads'), Desk Phones ('desk-phones'), Business Cards ('business-cards'), Martial Arts Gym ('martial-arts-gym'), GoHighLevel ('gohighlevel'), Quotes & Proposals ('proposals'), Project Preview ('project-preview'), Restaurant ('restaurant'), Shopify Commerce ('shopify'), Klaviyo ('klaviyo') — the same list apps.list_directory marks as native, and the same Install button on the Apps screen. A native app is a feature shipped inside the product, so this issues no token, grants no scopes, and sends no data to any third party; it simply enables that feature's screens and, for integration apps like GoHighLevel and Klaviyo, unlocks their capability domains (which refuse with app_required until the app is installed). PAID native apps are NOT granted by this: unless the account already owns the app (check apps.entitlement), the install is refused with payment_required and the purchase must go through apps.start_purchase / apps.complete_purchase — exactly the same gate the Install button enforces, so this is never a way to get an app the account hasn't bought. Reinstalling an owned app is free and reactivates every licence the account holds.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.install_native \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "example"
  }'

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

List the apps this agency owns (drafts and published), newest first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.list \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'

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

Browse apps that can be installed into this account — everything listed publicly, plus this agency's own apps (so you can install one before it's listed). Each app includes its cumulative download count across accounts, and an `is_owner` flag that is true for apps this account publishes (those can be managed in the developer portal). In a client account of a reselling agency, apps the agency's licence covers show the AGENCY's price (`sold_by_agency: true`, bought with apps.start_reseller_checkout) or are free (`included_by_agency: true`) instead of the marketplace's own price.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.list_directory \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'

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

List the apps installed in this account, with their granted scopes and status.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.list_installs \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'

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

List the custom pages contributed by active apps installed in this account — first-party native apps (each gated by its own feature flag) plus external/hosted Marketplace apps when the app platform is on. This is the member-safe mobile navigation view: it returns only page labels and in-app routes, never install tokens, secrets, granted scopes, or configuration. Read-only.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.list_mobile_pages \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

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

List the published version history and app-owned release notes for one app installed in this account. This is the app's own What's new feed, separate from the product-wide release feed.

Parameters

Example

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

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

List version updates for apps installed in this account. Each result identifies the installed version, newest published version, app-specific release notes, and whether an update is available. Marketplace app changes live here instead of the product-wide What's new feed.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.list_updates \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "available_only": true
  }'

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

Publish an immutable version of an app: its manifest (the pages/widgets/cards/actions it adds) and, for a PLATFORM-HOSTED app, its `document` — a single self-contained HTML page (inline CSS/JS + the App SDK) served in a sandboxed iframe. This is how an AI agent ships an app it wrote onto the marketplace. It is OUTWARD-FACING AND PERMANENT: a published version cannot be edited or unpublished, a listed app's new installs pin it straight away, and the code in `document` runs inside other people's accounts. Version labels are unique per app, so a mistake can only be superseded, never withdrawn.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.publish_version \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "version": "example"
  }'

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

Issue a fresh access token for an installed app and invalidate the old one immediately. Use if a token may have leaked. The new token is shown once.

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

Example

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

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

Prepare the payment form for a PAID app in THIS account. Creates an internal pending order and may create a short-lived Stripe CustomerSession to show an existing saved card; it does not create a Stripe PaymentIntent, charge money, or install the app. Submit payment details with apps.complete_purchase. Free apps use apps.install instead. Refused in a client account whose agency resells the app: an app the agency sells is bought with apps.start_reseller_checkout (paid to the agency), and one the agency includes installs free.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.start_purchase \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "price_option_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "instance_name": "Example"
  }'

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

For a client account whose agency sells this app at its own price: open a Stripe Checkout page on the AGENCY's own Stripe account and return its URL for a person to pay on. Creating it charges nothing — the buyer enters their card on Stripe's page, the money goes to the agency (the platform takes no cut), and the app then switches on in this account automatically. Creates a pending sale the agency can see, and on first sale the app's product on the agency's Stripe. Refused when the agency does not sell the app (use apps.start_purchase or apps.install), when this account already owns it, or when the agency has not connected a Stripe account that can take live payments.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.start_reseller_checkout \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "slug": "example"
  }'

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

For an app your agency OWNS, how many accounts have installed it — total, active, revoked, and suspended. This is your developer analytics: it counts installs across all accounts (aggregate only, it never reveals which accounts).

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.stats \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

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

Move a draft app into the platform review queue so it can be approved and listed on the marketplace. This hands the app, its published code and its listing copy to platform reviewers outside this agency, and approval puts it in front of every account on the platform. The app must have a published version first.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.submit_for_review \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "app_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

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

Revoke an app's install in this account. Its access token stops working immediately and the app can no longer reach any of this account's data. If the app is on a paid subscription this ALSO cancels that subscription at the end of the current period — billing stops, access continues until the period ends, and it can be reinstalled free until then, after which it switches off. Uninstalling never refunds and never destroys a one-time purchase: an app bought outright can always be reinstalled at no charge.

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

Example

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

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

Turn OFF one of the platform's built-in (native) apps for this account (Browser Agent ('browser-agent'), Directories ('directories'), Domain Leads ('domain-leads'), Desk Phones ('desk-phones'), Business Cards ('business-cards'), Martial Arts Gym ('martial-arts-gym'), GoHighLevel ('gohighlevel'), Quotes & Proposals ('proposals'), Project Preview ('project-preview'), Restaurant ('restaurant'), Shopify Commerce ('shopify'), Klaviyo ('klaviyo')) — the trash-can Uninstall on the Apps screen. The feature's screens disappear from the account and, for integration apps like GoHighLevel and Klaviyo, their capability domains start refusing with app_required. If the app is on a paid subscription this ALSO cancels that subscription at the end of the current paid period — billing stops, and the app can be reinstalled free until the period runs out. Uninstalling never refunds and never destroys a one-time purchase (an app bought outright reinstalls free forever, via apps.install_native), and data the app already imported into this account stays.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/apps.uninstall_native \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "example"
  }'

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

Update an app's details, pricing, requested scopes, or visibility (private/unlisted). Doesn't change review status. Omitted fields are left alone. This edits a LISTED app too, not only a draft: the name, copy and price change on the public marketplace card immediately, with no re-review, and price_cents is what the next buyer is really charged. Repointing external_base_url moves every installed copy's UI to a different server.

Parameters

Example

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

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