Skip to main content
POST
/
campaigns
Create a campaign
curl --request POST \
  --url https://api.pamhq.com/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
  }
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "type": "recall",
    "mode": "one_time",
    "status": "draft",
    "scheduled_launch_at": "2023-11-07T05:31:56Z",
    "window_duration_hours": 123,
    "enrolled_count": 123,
    "agents": {},
    "steps": [
      {
        "channel": "sms",
        "delay_hours": 1
      }
    ],
    "config": {
      "recall_id": "<string>",
      "offer_description": "<string>",
      "offer_expiration": "<string>",
      "opt_out_message": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "<string>"
  }
}

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.

Authorizations

Authorization
string
header
default:pk_live_your_api_key
required

API key provided as Authorization: Bearer <key>.

Body

application/json
name
string
required
Maximum string length: 255
type
enum<string>
required
Available options:
recall,
retention,
custom
steps
object[]
required
Minimum array length: 1
scheduled_launch_at
string<date-time>
required
mode
enum<string>
default:one_time
Available options:
one_time,
automation
agents
object

Optional explicit agent IDs for custom campaigns.

window_duration_hours
integer
Required range: 1 <= x <= 24
config
object

Response

Campaign created

data
object
meta
object