Workspace

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

Cancel the account deletion request

workspace.cancel_deletion_requestwriteconfirmowner only

Withdraws an open request to delete this account, so nothing will be deleted. Safe to call at any point before the deletion actually happens; after that there is nothing to cancel. Any provider integrations that were revoked when the request was raised stay revoked and have to be reconnected — reconnecting is a normal action in Settings → Integrations. Owner only.

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
reason	string	optional	Optional note recorded with the withdrawal, for the audit trail.

Example

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

Test with your API key

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

Check the account deletion request

workspace.deletion_request_statusreadowner only

Reports whether this account has an open deletion request, when it was raised, whether Chirply has confirmed it, and the earliest date the account could be deleted. Reads only — it changes nothing and starts no countdown.

Parameters

No parameters — POST an empty body.

Example

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

Test with your API key

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

Export account data

workspace.exportreadconfirmadmin only

Produces a downloadable ZIP archive of this account's own business data — contacts, companies, deals, tasks, appointments, conversations and full message bodies, call metadata and transcripts, invoices and orders, forms and their responses, custom objects, the activity log and the unsubscribe/do-not-call lists — as one CSV per dataset plus a manifest.json listing row counts and everything deliberately left out. Returns a signed download URL that expires in 15 minutes, NOT the rows themselves; fetch the URL to get the file. Nothing is changed or deleted. The archive never contains provider credentials, API keys, encrypted columns, customer-facing bearer tokens, or any other account's data.

Also answers to download my data, export everything, data portability, back up my workspace, get my data out.

Parameters

Field	Type	Required	Description
entities	string[]	optional	Limit the archive to these datasets, by key. Omit for everything. Valid keys: contacts, contact_phone_numbers, companies, tags, contact_tags, lists, list_contacts, pipelines, pipeline_stages, deals, tasks, conversations, messages, calls, call_dispositions, booking_event_types, booking_appointments, invoices, invoice_items, invoice_payments, funnel_orders, funnel_order_items, forms, form_responses, custom_field_defs, co_types, co_fields, co_records, activities, suppressions, dnc_entries. Use this when one dataset is very large and you want it on its own.

Example

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

Test with your API key

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

List exportable datasets

workspace.list_export_datasetsreadadmin only

Lists every dataset a workspace export can contain — the key to pass to workspace.export, the file name it lands under, its columns, and a plain-language description — together with the list of things deliberately excluded from any export and why. Reads nothing from the database and changes nothing.

Also answers to what can I export, export contents.

Parameters

No parameters — POST an empty body.

Example

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

Test with your API key

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

Request deletion of this account

workspace.request_deletionwriteconfirmowner only

Asks Chirply to delete this entire account and everything in it — every contact, conversation, call recording, campaign, funnel and file. Deletion is completed within 90 days after the request is confirmed, and sometimes sooner, as described at chirply.io/legal/data-deletion. This does NOT delete anything now: it records the request, and it can be withdrawn at any time until the deletion is carried out using workspace.cancel_deletion_request. Once carried out the deletion is permanent and there is no recycle bin. Records Chirply must keep to meet a legal, tax or accounting obligation are retained or anonymized rather than deleted — invoices, payments, payouts, signed agreements and do-not-contact entries. Export anything you want to keep first. Owner only.

Parameters

Field	Type	Required	Description
confirm_workspace_name	string	required	The exact name of this account, typed back as confirmation. The request is refused if it does not match, so an agent cannot start a deletion countdown on an account it only half-identified.
reason	string	optional	Optional free text explaining why the account is being closed. Stored with the request for support; never used to decide anything.
revoke_integrations	boolean	optional	Also revoke the access tokens this account granted to connected providers (Meta, Klaviyo, DigitalOcean) immediately, rather than in 90 days. Recommended: the grant cannot be revoked once the stored credential is deleted. Reconnecting later is a normal, one-minute action, so this is reversible. Default: false

Example

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

Test with your API key

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