POST /api/outbound-callRequest
string
required
Bearer YOUR_API_KEY — from Settings → Developer API once API access is enabled for the workspace.string
required
application/jsonstring
required
The number to call, in international format:
+919845012345.string
required
The UUID of the agent that should handle the call. Open your agent in AI Voice → My Agents to copy the Agent ID shown next to the agent name at the top of the configuration page (e.g.
e320872e-1781-4fab-83da-1b009db7748d).string
required
Your workspace slug, e.g.
acmeclinic. It selects the phone line and credentials used for the call.string
required
The Phone Number Record ID (UUID) of the specific phone line in your workspace to dial out from (e.g.
f47ac10b-58cc-4372-a567-0e02b2c3d479). You can find this ID in Settings → Phone Numbers & Telephony.string
The person’s name. The agent uses it wherever your script says
{{customer_name}}. Defaults to Customer.object
Any extra values your script refers to. Each key becomes a placeholder —
amount_due becomes {{amount_due}}.Example
Response
boolean
true when the call was accepted by the carrier.string
Identifier for this call, useful when matching it to a row in Call Logs.
Errors
Failures come back withsuccess: false and a human-readable message.
