← All action domains

Dialer settings

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.

Follow the account settings again

dialer_settings.follow_workspacewrite

Drop a call queue's own dialer settings so it goes back to using the account defaults — and keeps following them as they change. Nothing about the account defaults themselves is altered.

Parameters

FieldTypeRequiredDescription
queue_idstring (uuid)requiredThe call queue whose own settings should be dropped.

Example

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

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

Dialer settings

dialer_settings.getread

Read how the power dialer and the predictive dialer are set to behave — pace, whether an outcome is required, voicemail drop, lines per rep, answering-machine screening, whether AI answers first, and the calling window. Omit queue_id for the account defaults; pass one to see what that queue actually uses, which is the defaults with its own overrides applied.

Parameters

FieldTypeRequiredDescription
queue_idstring (uuid)optionalThe call queue to read or change. Omit to read or change the WORKSPACE defaults that every queue inherits.

Example

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

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

Change dialer settings

dialer_settings.updatewriteconfirmadmin only

Change how the dialers behave. Only the fields you pass are changed; everything else keeps its current value. Omit queue_id to move the WORKSPACE defaults — which also moves every queue that has never disagreed with the setting you're changing. Pass queue_id to change one queue only. This spends nothing by itself, but it decides how hard the dialer works: raising lines_per_agent reaches more people per hour and drops more calls, and turning the AI on puts a synthetic voice in front of every person who answers. A session already running keeps the settings it started with.

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

FieldTypeRequiredDescription
queue_idstring (uuid)optionalThe call queue to read or change. Omit to read or change the WORKSPACE defaults that every queue inherits.
settingsmap of string → objectrequiredThe settings to change, in the same shape `dialer_settings.get` returns — an object with `power` and/or `predictive` keys. Only the fields present are changed. See that action's output for the full field list and what each one does.

Example

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

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