Setup

Mark the first-run tour as done for a person, so the welcome overlay stops appearing when they sign in. Use this to stop showing it to someone who already knows the product. It is fully reversible with onboarding.restart, and it changes nothing else — no setup-guide item is ticked off, because that guide reads live evidence from the account rather than anyone's say-so.

Also answers to dismiss the welcome tour, stop showing the getting-started overlay.

Parameters

Example

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

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

Read whether a person has been through the first-run product tour — the short welcome sequence covering the AI key, the assistant, the setup guide and the community — how far they got, and which step they are on. Read-only: it changes nothing, shows nobody anything, and touches no customer data.

Also answers to welcome tour status, has the product tour been shown.

Parameters

Example

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

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

Show the first-run tour again from the beginning next time this person opens the app — the usual reason being a new teammate on an existing seat, or someone who skipped it and wants it back. It is an overlay they can close at any time, so the worst case is one extra click; nothing is sent, spent, or reset in the account itself.

Also answers to show the welcome tour again, reset getting started.

Parameters

Example

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

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

Move a person's bookmark in the first-run tour so their next visit resumes at that step. The step index only ever moves FORWARD — to send someone back to the beginning use onboarding.restart. Affects nothing but which screen of a five-screen overlay they next see; it sends nothing and spends nothing.

Also answers to bookmark the welcome tour, resume the product tour at a step.

Parameters

Example

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

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

Inspect ten active client accounts under this agency, with live setup progress, missing requirements, first-outcome evidence, assigned owners, due dates, next actions and snoozes. Includes up to 500 current agency teammates for assignment; larger team inventories are reported unavailable. Completion comes from evidence and regressions reopen attention. Exceptions sort first within the inspected page. Failed checks stay unavailable. Read-only; sends no messages or provider requests that incur charges.

Parameters

Example

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

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

Create one reusable contact-form starter in this account, with lead fields and a thank-you message ready to edit. It stays a private draft until you publish it separately. Repeating this action opens the same form and preserves its edits and current publication state. Existing form plan limits apply. Sends no messages, starts no workflows, publishes nothing, and spends no money.

Also answers to quick setup lead form, create a starter contact form.

Parameters

No parameters — POST an empty body.

Example

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

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

Read the account's available first-win goals, saved focus, practical steps, personalized setup path, required progress, next best action, and feature prerequisites. This is read-only and recomputes provider health, published content, and customer-activity evidence live; it never changes setup or starts customer work.

Also answers to onboarding status, launch checklist, activation progress.

Parameters

No parameters — POST an empty body.

Example

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

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

Read whether the calling person dismissed the optional getting-started banner in this account. This personal preference is independent of the shared first-win goal and welcome tour; a saved goal can also hide the banner. The setup guide stays available through Help & setup. Read-only: changes nothing, sends nothing, and spends no money. Requires a calling user and cannot read another person's preference.

Parameters

No parameters — POST an empty body.

Example

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

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

Read the latest twenty recorded owner, next-action, due-date and snooze changes for one client setup task, with the total change count. Restricted to managers of its current parent agency. Internal read only; sends nothing, changes nothing and spends no money.

Parameters

Example

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

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

Assign an existing agency teammate, record an internal next action and due date, or snooze a client setup task for up to 30 days. Rejects stale revisions and records each change in history. Completion always comes from live setup evidence; this never marks a client ready, grants access, notifies anyone, sends a message, or spends money.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/setup.save_launch_followthrough \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "task_key": "profile",
    "owner_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "next_action": "example",
    "due_on": "2026-09-17",
    "snoozed_until": "2026-09-17",
    "expected_revision": 1
  }'

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

Choose a local-business or sales-team setup checklist for one client belonging to this agency. Changes checklist priorities only; installs no assets, enables no workflows, sends no messages, and spends no money.

Parameters

Example

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

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

Save the account's first-win focus: organize contacts, capture leads, book appointments, set up follow-up, or launch agency clients. Changes guidance only; creates no customer records, sends no messages, activates no workflows, and spends no money. The choice is shared across this account and can be changed later.

Also answers to choose first win, what should I focus on, personalize getting started.

Parameters

Example

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

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

Set whether this account is launching as an agency, local business, or sales team. This changes setup-checklist prioritization only; it sends nothing, starts no workflow or customer action, and spends no money.

Also answers to choose onboarding path, personalize launch checklist.

Parameters

Example

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

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

Hide or restore the optional getting-started banner for the calling person in this account, across their devices. Set dismissed to true to hide it or false to restore it when no first-win goal is saved. Changes no teammate's preference, account goal, welcome-tour progress, or setup evidence; the guide stays available through Help & setup. Sends nothing and spends no money. Requires a calling user and cannot change another person's preference.

Also answers to hide getting started, restore getting-started banner.

Parameters

Example

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

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