Skip to main content
POST
/
outbound
/
calls
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "data": {
    "id": "<string>",
    "status": "queued"
  },
  "message": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Clerk JWT (browser). Requires Authorization: Bearer <clerk_jwt> and the X-Organization-Id header. Validated by the ported Clerk middleware, which sets the app.current_organization_id RLS context.

Headers

Idempotency-Key
string

Client-supplied idempotency key on mutating POSTs (API-First).

Body

application/json
agentId
string
required

The agent that places the call (must belong to your org).

callerNumberId
string
required

The caller-ID number id — an org-owned, trunk-provisioned DID.

toNumber
string
required

The recipient phone number; normalized to E.164 (an invalid number is rejected 400).

The lawful basis to place this call. A consumer audience REQUIRES a resolved basis (pewc, express, or ebr); none is only valid for a business audience.

Available options:
pewc,
express,
ebr,
none
recipientName
string

Optional recipient name (also a merge variable for the greeting).

variables
object

Optional merge variables for the greeting / playbook.

audienceType
enum<string>
default:consumer
Available options:
consumer,
business

Response

The call was queued for dialing.

success
boolean
required
data
object
required
message
string
errors
object[]