Skip to main content
POST
/
outbound
/
agents
/
{agent_id}
/
outbound-config
Configure Outbound Calling
curl --request POST \
  --url https://api.example.com/outbound/agents/{agent_id}/outbound-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phone_numbers": [
    {
      "phone_number": "<string>",
      "display_name": "<string>",
      "is_default": false,
      "enabled": true,
      "daily_limit": 5000,
      "metadata": {}
    }
  ],
  "schedules": [
    {
      "name": "<string>",
      "time_windows": [
        {
          "start_time": "<string>",
          "end_time": "<string>",
          "days_of_week": [
            123
          ],
          "timezone": "UTC"
        }
      ],
      "enabled": true,
      "max_concurrent_calls": 1,
      "call_interval_seconds": 0,
      "respect_dnc": true,
      "respect_timezone": true
    }
  ],
  "default_schedule_id": "<string>"
}
'
{
  "agent_id": "<string>",
  "phone_numbers": [
    {
      "phone_number": "<string>",
      "display_name": "<string>",
      "is_default": false,
      "enabled": true,
      "daily_limit": 5000,
      "metadata": {}
    }
  ],
  "schedules": [
    {}
  ],
  "default_schedule_id": "<string>",
  "total_calls_today": 123,
  "calls_remaining_today": 123,
  "can_call_now": true,
  "next_available_time": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mrassistant.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id
string<uuid>
required

Body

application/json

Complete outbound calling configuration.

agent_id
string<uuid>
required
phone_numbers
OutboundPhoneNumber · object[]
required
Minimum array length: 1
schedules
CallingSchedule · object[]
required
Minimum array length: 1
default_schedule_id
string | null

Response

Successful Response

Outbound configuration response.

agent_id
string
required
phone_numbers
OutboundPhoneNumber · object[]
required
schedules
Schedules · object[]
required
default_schedule_id
string | null
required
total_calls_today
integer
required
calls_remaining_today
integer
required
can_call_now
boolean
required
next_available_time
string | null
required