Skip to main content
POST
Test an app action tool

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Path Parameters

toolId
string<uuid>
required

ID of the app action tool (the id in GET /tools).

Body

application/json
values
object

Sample values for the fields the assistant fills, keyed by each field's param (the parameter name the assistant sees, for example start_time for the field key startTime), not by key. For a field in mode variable, the variable name, for example caller_number, works too.

mode
enum<string>
default:dry_run

dry_run maps the values without sending an action that changes data to the app. live sends it (with confirm_write: true). Actions that only read data always run.

Available options:
dry_run,
live
confirm_write
boolean
default:false

Required with mode: live for an action that changes data. It changes real data in the app.

Response

Test result. Inspect envelope.ok; app failures also return HTTP 200.

data
object
required