← All action domains

Concepts

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

Explain a concept

concepts.explainread

Explain one Chirply concept in full: what it is, why a business would use it, how the rest of the product uses it, a worked example, and — most usefully — what it is NOT, so a list is not confused with a smart segment or a company with a client account. Accepts the user's own words ('smart segments', 'dynamic list', 'what's a tag'). Read-only and free.

Also answers to what is, define, difference between.

Parameters

FieldTypeRequiredDescription
conceptstringrequiredThe concept to explain — its glossary key ('smart-segment'), the word shown in the app ('Smart Segments'), or how the user said it ('dynamic list').

Example

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

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

Browse the glossary

concepts.listread

List every Chirply concept the product explains in plain language — accounts and client accounts (client accounts), contacts, companies, lists, smart segments, tags, custom fields, lifecycle stages, unsubscribes, deals, campaigns and workflows — each with the one-line summary shown in the app. Read-only, costs nothing, and returns the same wording the user sees on screen.

Also answers to glossary, what does this word mean, product terminology.

Parameters

FieldTypeRequiredDescription
searchstringoptionalOnly concepts whose name, summary or search words contain this text.

Example

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

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