Create Outbound Call - Zeeg Developer Hub

POST

agents

{agentUuid}

outbound-calls

curl --request POST \
  --url https://api.zeeg.me/v2/agents/{agentUuid}/outbound-calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "+4915112345678"
}
'

{
  "success": true,
  "element": {
    "id": "d05565a7-fe5e-4036-ae0d-c1132fb91543",
    "agentId": "3b7123e8-78f7-42c1-bf4d-646ee06d4ddf",
    "phoneNumber": "+4915112345678",
    "email": "sophie.laurent@northwind.io",
    "fullName": "Sophie Laurent",
    "additionalData": "Sophie is interested in the enterprise plan. She prefers to speak in English.",
    "firstMessage": null,
    "scheduledTime": null,
    "triggeredAt": null,
    "status": "pending",
    "callLogId": null,
    "callLog": null,
    "error": null,
    "retryLogs": [],
    "createdAt": "2026-04-15T10:00:00.000000Z",
    "updatedAt": "2026-04-15T10:00:00.000000Z"
  }
}

{
  "success": false,
  "message": "Agent is not active",
  "status": 400
}

{
  "message": "Unauthenticated."
}

{
  "error": {
    "type": "insufficient_scope",
    "message": "Your token is missing the required scope: outbound-calls:write.",
    "error_id": "e801df23-9daa-456e-86b5-acae04f36163",
    "required_scopes": [
      "outbound-calls:write"
    ]
  }
}

{
  "error": "Agent not found"
}

{
  "message": "The given data was invalid.",
  "errors": {
    "phoneNumber": [
      "The phone number must be in E.164 format."
    ],
    "scheduledTime": [
      "The scheduled time must be a date after now."
    ]
  }
}

{
  "success": false,
  "message": "Invalid UUID format.",
  "status": 500
}

Authorizations

Authorization

string

header

required

Path Parameters

agentUuid

string<uuid>

required

The UUID of the AI agent.

Body

application/json

phoneNumber

string

required

Phone number in E.164 format (e.g. +4915112345678).

string<email>

Email address of the person to call. Optional.

fullName

string

Full name of the person to call. Optional.

additionalData

string

Additional context for the AI agent to use during the call.

scheduledTime

string

Schedule the call for a future time. Format: YYYY-MM-DD HH:mm:ss. Must be in the future.

Response

Created

success

boolean

element

object

Hide child attributes

element.id

string<uuid>

Example:

"d05565a7-fe5e-4036-ae0d-c1132fb91543"

element.agentId

string<uuid>

Example:

"3b7123e8-78f7-42c1-bf4d-646ee06d4ddf"

element.phoneNumber

string

element.email

string<email>

element.fullName

string

element.additionalData

string | null

element.firstMessage

string | null

element.scheduledTime

string | null

element.triggeredAt

string | null

element.status

enum<string>

Available options:

pending,

completed,

failed

element.callLogId

integer | null

element.callLog

object | null

element.error

string | null

element.retryLogs

any[]

element.createdAt

string<date-time>

element.updatedAt

string<date-time>

Last modified on April 29, 2026

curl --request POST \
  --url https://api.zeeg.me/v2/agents/{agentUuid}/outbound-calls \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "+4915112345678"
}
'

{
  "success": true,
  "element": {
    "id": "d05565a7-fe5e-4036-ae0d-c1132fb91543",
    "agentId": "3b7123e8-78f7-42c1-bf4d-646ee06d4ddf",
    "phoneNumber": "+4915112345678",
    "email": "sophie.laurent@northwind.io",
    "fullName": "Sophie Laurent",
    "additionalData": "Sophie is interested in the enterprise plan. She prefers to speak in English.",
    "firstMessage": null,
    "scheduledTime": null,
    "triggeredAt": null,
    "status": "pending",
    "callLogId": null,
    "callLog": null,
    "error": null,
    "retryLogs": [],
    "createdAt": "2026-04-15T10:00:00.000000Z",
    "updatedAt": "2026-04-15T10:00:00.000000Z"
  }
}

{
  "success": false,
  "message": "Agent is not active",
  "status": 400
}

{
  "message": "Unauthenticated."
}

{
  "error": {
    "type": "insufficient_scope",
    "message": "Your token is missing the required scope: outbound-calls:write.",
    "error_id": "e801df23-9daa-456e-86b5-acae04f36163",
    "required_scopes": [
      "outbound-calls:write"
    ]
  }
}

{
  "error": "Agent not found"
}

{
  "message": "The given data was invalid.",
  "errors": {
    "phoneNumber": [
      "The phone number must be in E.164 format."
    ],
    "scheduledTime": [
      "The scheduled time must be a date after now."
    ]
  }
}

{
  "success": false,
  "message": "Invalid UUID format.",
  "status": 500
}