Privacy

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

Turn off privacy mode

privacy.disablewriteconfirm

Turn privacy mode off, making every hidden value readable again across the whole app — contact names, phone numbers, email addresses, message content and API keys included. Only do this when the user has confirmed they are no longer sharing their screen or recording; if they are, this puts their customers' personal information straight back on the stream.

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
user_id	string (uuid)	optional	Whose privacy mode to change. Defaults to the calling user. API keys have no user of their own and MUST pass this. Changing someone else's requires the admin or owner role, and they must be a member of this organization.

Example

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

Test with your API key

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

Turn on privacy mode

privacy.enablewrite

Turn on privacy mode so the user can share their screen, demo, or record a walkthrough safely. Sensitive values are blurred on screen immediately: contact names and details, conversation and call content, and API keys are ALWAYS hidden, plus whichever optional categories the user has chosen. Nothing is deleted and no permissions change — this only affects what is legible on screen. Optionally pass `also_hide` to switch extra categories on at the same time.

Parameters

Field	Type	Required	Description
user_id	string (uuid)	optional	Whose privacy mode to change. Defaults to the calling user. API keys have no user of their own and MUST pass this. Changing someone else's requires the admin or owner role, and they must be a member of this organization.
also_hide	array of ("revenue" \| "customer_value" \| "billing" \| "team" \| "metrics" \| "identity")	optional	Optional categories to switch on as well as turning privacy mode on. One or more of: "revenue" (Your revenue), "customer_value" (What each customer has paid), "billing" (Your own subscription & billing), "team" (Your team's names & emails), "metrics" (Volumes & performance), "identity" (Your own name & workspace).

Example

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

Test with your API key

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

Privacy mode

privacy.get_settingsread

Read the user's screen-share privacy settings: whether privacy mode is on, which classes of information it is hiding, and whether redaction is `partial` (a short readable prefix survives on names, phone numbers and emails) or `full` (nothing survives). Also returns the full catalog of categories, marking the three that are always hidden (contact details, conversations, and keys) and the six the user can choose.

Parameters

Field	Type	Required	Description
user_id	string (uuid)	optional	Whose privacy mode to change. Defaults to the calling user. API keys have no user of their own and MUST pass this. Changing someone else's requires the admin or owner role, and they must be a member of this organization.

Example

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

Test with your API key

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

Hide more in privacy mode

privacy.hidewrite

Switch additional optional categories on, so privacy mode also hides them. Use this for the user's own commercially sensitive figures — their revenue, what individual customers have paid, their subscription, their teammates' names, their volumes, or their own name and account. Takes effect immediately if privacy mode is on, and is remembered for next time if it isn't. Contact details, conversations and keys don't need to be listed here: they are always hidden.

Parameters

Field	Type	Required	Description
user_id	string (uuid)	optional	Whose privacy mode to change. Defaults to the calling user. API keys have no user of their own and MUST pass this. Changing someone else's requires the admin or owner role, and they must be a member of this organization.
categories	array of ("revenue" \| "customer_value" \| "billing" \| "team" \| "metrics" \| "identity")	required	Categories to start hiding. One or more of: "revenue" (Your revenue), "customer_value" (What each customer has paid), "billing" (Your own subscription & billing), "team" (Your team's names & emails), "metrics" (Volumes & performance), "identity" (Your own name & workspace).

Example

curl -X POST https://app.chirply.io/api/v1/actions/privacy.hide \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "categories": [
      "revenue"
    ]
  }'

Test with your API key

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

Stop hiding a category

privacy.revealwriteconfirm

Stop hiding one or more optional categories, making those values readable again even while privacy mode stays on — for example to show revenue during a sales demo. This exposes real figures on screen, so confirm the user actually wants them visible. It cannot unhide contact details, conversation content or API keys: those stay hidden whenever privacy mode is on.

Parameters

Field	Type	Required	Description
user_id	string (uuid)	optional	Whose privacy mode to change. Defaults to the calling user. API keys have no user of their own and MUST pass this. Changing someone else's requires the admin or owner role, and they must be a member of this organization.
categories	array of ("revenue" \| "customer_value" \| "billing" \| "team" \| "metrics" \| "identity")	required	Categories to stop hiding. One or more of: "revenue" (Your revenue), "customer_value" (What each customer has paid), "billing" (Your own subscription & billing), "team" (Your team's names & emails), "metrics" (Volumes & performance), "identity" (Your own name & workspace).

Example

curl -X POST https://app.chirply.io/api/v1/actions/privacy.reveal \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "categories": [
      "revenue"
    ]
  }'

Test with your API key

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

How much to hide

privacy.set_strengthwriteconfirm

Choose how much of a redacted identity stays readable. `partial` (the default) leaves the first few characters of names, phone numbers, emails and addresses legible — 'Sar…', '+1 (415) …' — so the user can still tell rows apart and talk about one while demoing, without anyone being identifiable. `full` blurs them completely, for a recording that will be published. Either way this only affects IDENTITIES: money and counts are always hidden whole, because the leading digits of a figure give the figure away.

Parameters

Field	Type	Required	Description
user_id	string (uuid)	optional	Whose privacy mode to change. Defaults to the calling user. API keys have no user of their own and MUST pass this. Changing someone else's requires the admin or owner role, and they must be a member of this organization.
strength	"partial" \| "full"	required	"partial" keeps a short readable prefix on names and numbers; "full" hides them completely.

Example

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

Test with your API key

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