Skip to main content
GET
/
api
/
campaigns
/
{id}
Error
A valid request URL is required to generate request examples
{
  "_id": "<string>",
  "accountId": "<string>",
  "name": "<string>",
  "agentConfigId": "<string>",
  "channel": "whatsapp",
  "status": "draft",
  "schedule": {
    "startAt": "2023-11-07T05:31:56Z",
    "rateLimit": 5,
    "activeHours": {
      "start": "09:00",
      "end": "17:00",
      "timezone": "America/New_York"
    },
    "activeDays": [
      1,
      2,
      3,
      4,
      5
    ]
  },
  "leads": [
    {
      "leadId": "<string>",
      "conversationId": "<string>",
      "sentAt": "2023-11-07T05:31:56Z",
      "error": "<string>"
    }
  ],
  "stats": {
    "totalLeads": 0,
    "sent": 0,
    "delivered": 0,
    "replied": 0,
    "qualified": 0,
    "disqualified": 0,
    "failed": 0
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "leadFilter": {
    "statuses": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ],
    "importedAfter": "2023-11-07T05:31:56Z"
  },
  "advancedFilter": {
    "conditions": [
      {
        "field": "<string>",
        "operator": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "manualLeadIds": [
    "<string>"
  ]
}

Documentation Index

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

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

Authorizations

​
X-API-Key
string
header
required

API key for programmatic access. Keys use the format nl_live_<64 hex> or nl_test_<64 hex> and are scoped to an account's RBAC permissions.

Path Parameters

​
id
string
required

Campaign ID (MongoDB ObjectId)

Example:

"665a1b2c3d4e5f6a7b8c9d0e"

Response

Campaign details

A campaign orchestrates batch AI-driven outreach to leads.

​
_id
string
required

Unique campaign identifier

​
accountId
string
required

Account that owns this campaign

​
name
string
required

Campaign display name

​
agentConfigId
string
required

Reference to the AI agent configuration used for conversations

​
channel
enum<string>
default:whatsapp
required

Messaging channel for outreach

Available options:
whatsapp,
telegram,
email
​
status
enum<string>
default:draft
required

Current campaign lifecycle status

Available options:
draft,
scheduled,
running,
paused,
completed
​
schedule
object
required

Campaign scheduling and rate limit configuration.

​
leads
object[]
required

Per-lead tracking for the campaign

​
stats
object
required

Aggregate statistics for the campaign.

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
leadFilter
object

Basic lead filter criteria.

​
advancedFilter
object

Advanced filter with multiple conditions.

​
manualLeadIds
string[]

Explicitly selected lead IDs to include in the campaign