← All action domains

Client-account API (subaccounts)

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

Chirply's client-account API uses the subaccounts domain. Call subaccounts.list from an agency account with the Reseller client-account entitlement to retrieve its child accounts and allowance. The product calls them client accounts; the stable API names remain subaccounts.list, subaccounts.create and subaccounts.update.

Follow the integration recipe →
What does subaccounts.list return?

It returns the agency's client accounts and allowance in data.result: total, max_subaccounts and subaccounts. Client records include id, name, slug, status and created_at. The request body is an empty object.

What access is required?

Use an agency account with the Reseller client-account entitlement. Listing needs read scope; creating or editing needs write scope and admin-level authorization. Creation is also subject to the plan's client-account allowance.

Does a client ID switch the credential's account?

A returned client ID identifies the child account. It does not change the account a credential acts for. Verify the intended account with GET /api/v1 and authenticate for that account before accessing its CRM records.

Create a client account

subaccounts.createwriteadmin only

Create a client account under this agency. The URL slug is derived from the name and de-duplicated automatically. Fails once the reseller plan's client account allowance is used up.

Parameters

FieldTypeRequiredDescription
namestringrequiredThe client's account name, e.g. “Acme Roofing”.

Example

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

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

List client accounts

subaccounts.listread

List the client accounts under this agency, with how many of the plan's client account allowance are used.

Parameters

No parameters — POST an empty body.

Example

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

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

Edit a client account

subaccounts.updatewriteadmin only

Rename one of this agency's client accounts, or suspend/reactivate it. Suspending locks the account for everyone in it.

Parameters

FieldTypeRequiredDescription
idstring (uuid)requiredThe client account to edit.
namestringoptionalNew account name.
status"active" | "suspended"optionalsuspended locks the account; active restores it.

Example

curl -X POST https://app.chirply.io/api/v1/actions/subaccounts.update \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'
Test with your API key

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