Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "id": "obi_1a2b3c4d5e6f7890",
    "status": "queued"
  }
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Outbound

Enqueue a single outbound call

Enqueue ONE outbound voice call to a recipient. The call is not placed inline: this writes a normalized intent that the outbound worker schedules, compliance-gates (informational-only, callee quiet-hours, internal opt-out, and — for a consumer audience — a resolved consent basis), and dials when due; an answered call is billed per minute. message_category is always informational. A consumer audience requires a resolved consentBasis (pewc, express, or ebr); none is only valid for a business audience. Send an Idempotency-Key to make a retry safe; identical requests also collapse to one intent via a deterministic dedupe key. Returns 202 with the intent id. Use this for a single ad-hoc dial. To place many paced calls over a contact list, use a campaign instead (createOutboundCampaign + launchOutboundCampaign) — both dial through the same worker and compliance gate.

POST

/

outbound

/

calls

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "id": "obi_1a2b3c4d5e6f7890",
    "status": "queued"
  }
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Headers

Idempotency-Key

string

Client-supplied idempotency key on mutating POSTs. Retrying the same request with the same key returns the original result instead of creating a duplicate — send a fresh UUID per logical operation.

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.

Show child attributes

audienceType

enum<string>

default:consumer

Available options:

consumer,

business

Response

The call was queued for dialing.

success

boolean

required

data

object

required

Show child attributes

message

string

errors

object[]

Show child attributes