Readiness

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.

Confirm a setup step

readiness.acknowledgewrite

Mark an external setup step that can't be verified automatically (e.g. accepting Twilio's AI addendum, verifying DNS, registering A2P) as done for this account, or clear it with done=false. This only updates the advisory checklist — it does NOT perform the step itself. Steps that are detected automatically (a provider being connected) cannot be set here.

Parameters

Field	Type	Required	Description
feature	"ai_calling" \| "sms_texting" \| "custom_domains" \| "email_sending" \| "meta_social" \| "ai_studio" \| … 7 more	required	The feature the step belongs to.
requirement	string	required	The prerequisite key from readiness.status (only 'attest' steps can be set).
done	boolean	optional	false clears the confirmation. Default: true

Example

curl -X POST https://app.chirply.io/api/v1/actions/readiness.acknowledge \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "feature": "ai_calling",
    "requirement": "example"
  }'

Test with your API key

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

Feature setup checklist

readiness.listread

List every feature that needs setup before it will work (AI calling, business texting, custom domains, email, Facebook/Instagram), with each prerequisite and whether this account satisfies it yet — including the external steps only the user can do (accepting Twilio's AI addendum, verifying DNS, registering A2P, granting Meta permissions). Read-only.

Parameters

No parameters — POST an empty body.

Example

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

Feature setup status

readiness.statusread

Show the setup prerequisites and their satisfied/outstanding state for one feature. "feature" is one of: ai_calling, sms_texting, custom_domains, email_sending, meta_social, ai_studio, affiliate_payouts, restaurant, review_ingestion, contact_enrichment, tenant_subscriptions, white_label, directories. Read-only.

Parameters

Field	Type	Required	Description
feature	"ai_calling" \| "sms_texting" \| "custom_domains" \| "email_sending" \| "meta_social" \| "ai_studio" \| … 7 more	required	Which feature to check, e.g. 'ai_calling'.

Example

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

Test with your API key

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