BookFunnel

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.

Remove BookFunnel page

bookfunnel.forget_pagewriteconfirmadmin only

Remove one BookFunnel landing page from this account: its routing override and every stored webhook receipt that names it, which together are what make its section appear. Permanently deletes those receipt records, so the page's delivery history and any failed events waiting to be retried are lost. Contacts, lists, tags and automations are not touched, and no message is sent.

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

Field	Type	Required	Description
page_id	string	required	BookFunnel landing-page id to forget, exactly as it appears on its section heading.

Example

curl -X POST https://app.chirply.io/api/v1/actions/bookfunnel.forget_page \
  -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 bookfunnel_forget_page at https://app.chirply.io/api/mcp, same bearer token, same input.

Open BookFunnel settings

bookfunnel.get_settingsreadadmin only

Read the BookFunnel connection, default and landing-page routing, available destinations, and the latest 100 webhook receipts with processing errors. It never returns the private webhook token or URL credential and changes nothing.

Parameters

No parameters — POST an empty body.

Example

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

Test with your API key

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

Retry sync

bookfunnel.retry_eventwriteconfirmadmin only

Retry one failed BookFunnel webhook receipt. Contact upsert, tags and list membership are idempotent, but a selected automation may reach real people and spend money if the earlier attempt failed after partially starting it, so this always requires confirmation.

Parameters

Field	Type	Required	Description
event_id	string (uuid)	required	Failed BookFunnel event receipt to process again.

Example

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

Test with your API key

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

Save mapping

bookfunnel.save_mappingwriteconfirmadmin only

Set the list, tags and automation used for future BookFunnel new_subscriber events, either as the default or for one landing-page id. Saving sends nothing now, but the selected automation may send real email/SMS or spend money as soon as a real reader subscribes. Non-opt-in book_claimed events never use this routing.

Parameters

Field	Type	Required	Description
page_id	string (or null)	optional	BookFunnel landing-page id to override, or null to change the default routing. Default: null
destination	object	required	Where subscribers from this BookFunnel delivery land: an optional list, any tags to apply, and an optional automation to start.
destination.list_id	string (uuid) (or null)	optional	Static list in this account to add each new subscriber to, or null for no list. Default: null
destination.tag_ids	array of (string (uuid))	optional	Existing tag ids in this account to apply to each new subscriber. Default: []
destination.workflow_id	string (uuid) (or null)	optional	Automation to start for each new subscriber, or null for none. Default: null

Example

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

Test with your API key

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