curl --request POST \
  --url https://api.heylibby.com/api/v1/outbound/call \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agentId": "your-agent-uuid",
  "contact": {
    "phoneNumber": "+15551234567",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane@example.com"
  },
  "metadata": {
    "formLocation": "Ballard",
    "formGoals": "get in shape",
    "utmSource": "facebook"
  },
  "introMessage": "Hi Jane, this is Libby calling from Acme Fitness, calling you back about your membership inquiry...",
  "voicemailMessage": "Hi Jane, sorry we missed you. This is Libby from Acme Fitness. Call us back to learn about our May promotion..."
}
'

{
  "success": true,
  "message": "Your call has been scheduled and will be placed shortly."
}

Outbound Calling

Initiate outbound call

Schedule a single outbound call for a specific assistant (agentId). The call is queued after validation and placed shortly.

Required headers: x-api-key, Content-Type: application/json.

Required fields

agentId — assistant that places and handles the call, can be found in the URL after selecting that assistant.
contact.phoneNumber — callee number in E.164 format (e.g. +15551234567).
Messaging — send both introMessage and voicemailMessage, or send callInstructions alone. You cannot send only one of introMessage / voicemailMessage.

Optional fields

contact.firstName, contact.lastName, contact.email; trimmed and used for assistant context.
metadata — custom key/value pairs (strings, numbers, or booleans) to give the assistant context.

Assistant requirements The assistant must exist, belong to your organization (from the API key), be active, and have phone enabled and fully configured.

POST

outbound

call

curl --request POST \
  --url https://api.heylibby.com/api/v1/outbound/call \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agentId": "your-agent-uuid",
  "contact": {
    "phoneNumber": "+15551234567",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane@example.com"
  },
  "metadata": {
    "formLocation": "Ballard",
    "formGoals": "get in shape",
    "utmSource": "facebook"
  },
  "introMessage": "Hi Jane, this is Libby calling from Acme Fitness, calling you back about your membership inquiry...",
  "voicemailMessage": "Hi Jane, sorry we missed you. This is Libby from Acme Fitness. Call us back to learn about our May promotion..."
}
'

{
  "success": true,
  "message": "Your call has been scheduled and will be placed shortly."
}

Authorizations

x-api-key

string

header

required

API key secret from API Key Management. API Gateway validates the key and forwards the request to the outbound service.

Headers

Content-Type

enum<string>

required

Must be application/json.

Available options:

application/json

Body

application/json

agentId

string<uuid>

required

Agent that places and handles the call. Required.

contact

object

required

Show child attributes

metadata

object

Optional key/value context (e.g. form or UTM fields). Values may be strings, numbers, or booleans.

Show child attributes

introMessage

string

Message spoken when a human answers. Must be sent together with voicemailMessage, unless you use callInstructions instead.

voicemailMessage

string

Message left when voicemail is detected. Must be sent together with introMessage, unless you use callInstructions instead.

callInstructions

string

Instructions for the call when you are not providing introMessage and voicemailMessage. Use this option alone; do not send only one of the intro/voicemail pair.

Response

Call accepted and queued.

success

boolean

Whether the call was accepted and queued.

Example:

true

message

string

Human-readable confirmation.

Example:

"Your call has been scheduled and will be placed shortly."

Outbound Phone Calling API (Legacy)Manage campaign contacts

⌘I

Documentation Index

Authorizations

Headers

Body

Response