Skip to main content

Documentation Index

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

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

The PAM Outbound API is the external interface for launching and monitoring outbound customer engagement campaigns, calls, and SMS conversations. This prototype documents the public /v1 surface for campaigns, conversations, API keys, and webhooks. The API uses bearer API keys, JSON request bodies, cursor pagination, and a consistent response envelope.

​
Base URL

https://api.pamhq.com/v1
Use the environment-specific API host provided during onboarding. Endpoint paths in this documentation are relative to /v1.

​
Quick Start

Create an API key in the PAM dashboard or ask your PAM contact to provision an initial key. Then send it in the Authorization header: 
curl https://api.pamhq.com/v1/campaigns \
  -H "Authorization: Bearer $PAM_API_KEY"

​
Response Format

Successful responses return a data object or array plus request metadata: 
{
  "data": {
    "id": "camp_abc123"
  },
  "meta": {
    "request_id": "req_abc123"
  }
}
Errors use the same metadata envelope: 
{
  "error": {
    "code": "validation_error",
    "message": "name is required"
  },
  "meta": {
    "request_id": "req_abc123"
  }
}

​
What You Can Build

  • Use PAM’s state-of-the-art agents, or create your own for custom workflows.
  • Create recall, retention, and custom outbound campaigns.
  • Make calls and start SMS conversations with PAM agents.
  • Enroll contacts by uploading a CSV or sending a list of contacts.
  • Manage the lifecycle of your campaigns.
  • Pull campaign results and journey-level status.

​
Create Your First Campaign

curl https://api.pamhq.com/v1/campaigns \
  -X POST \
  -H "Authorization: Bearer $PAM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "March Service Recall",
    "type": "recall",
    "mode": "one_time",
    "steps": [
      { "channel": "sms", "delay_hours": 0 },
      { "channel": "voice", "delay_hours": 24 }
    ],
    "scheduled_launch_at": "2026-04-10T09:00:00Z",
    "window_duration_hours": 8,
    "config": {
      "recall_id": "24V-123",
      "opt_out_message": "Reply STOP to opt out"
    }
  }'

​
Create Your First Call

curl https://api.pamhq.com/v1/calls \
  -X POST \
  -H "Authorization: Bearer $PAM_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: call_01HV7K4ZD3Q9X8P1M8Y2K9A0BC" \
  -d '{
    "agentSlug": "recall-voice",
    "toNumber": "+15555550199",
    "fromNumber": "+15555550123",
    "dynamicVariables": {
      "customerName": "Ada",
      "dealershipName": "PAM Motors",
      "recallId": "24V-123"
    }
  }'

​
API Reference

The API Reference tab is generated from an OpenAPI 3.0 spec and includes interactive request builders for the implemented /v1 endpoints.