← All action domains

Appdata

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

Delete app data

appdata.deletewriteconfirm

Delete one value from your app's own data by collection + key.

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
collectionstringoptionalA namespace within your app's storage, e.g. 'settings'. Default: "default"
keystringrequiredThe record's key to delete.

Example

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

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

Read app data

appdata.getread

Fetch one value from your app's own data by collection + key. Returns null if absent.

Parameters

FieldTypeRequiredDescription
collectionstringoptionalA namespace within your app's storage, e.g. 'settings'. Default: "default"
keystringrequiredThe record's key.

Example

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

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

List app data

appdata.listread

List your app's stored records in a collection, optionally filtered by a key prefix.

Parameters

FieldTypeRequiredDescription
limitintegeroptionalMax rows to return (1–100). Default: 25
offsetintegeroptionalRows to skip. Default: 0
collectionstringoptionalA namespace within your app's storage, e.g. 'settings'. Default: "default"
prefixstringoptionalOnly keys starting with this.

Example

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

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

Store app data

appdata.setwrite

Store (create or overwrite) one value in your app's own data, keyed by collection + key, scoped to this install. Only your app can read it back.

Parameters

FieldTypeRequiredDescription
collectionstringoptionalA namespace within your app's storage, e.g. 'settings'. Default: "default"
keystringrequiredThe record's key within the collection.
valueanyrequiredAny JSON value to store.

Example

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

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