Skip to main content
POST
/
v1
/
campaigns
Create Campaign
curl --request POST \
  --url https://app-api.walead.ai/api/v1/campaigns \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "status": "active",
  "progress": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "settings": {},
  "coreVariables": {},
  "customVariables": {},
  "linkedinAccounts": [
    "<string>"
  ],
  "analytics": {
    "acceptanceRate": 123,
    "responseRate": 123,
    "totalLeads": 123
  }
}

​
Overview

Creates a new campaign in your workspace. If your workspace has only one LinkedIn account, it will be automatically associated with the campaign.

​
Authentication

All requests require an API key passed in the x-api-key header. You can generate your API key from the WaLead dashboard.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate from your WaLead dashboard.

Body

application/json

Campaign to create

​
name
string
required

Campaign name

Response

Campaign created successfully

​
id
string

Unique campaign identifier

​
name
string

Campaign name

​
status
enum<string>

Campaign status

Available options:
active,
paused,
completed,
error,
draft
​
progress
number

Campaign progress percentage (0-100)

​
createdAt
string<date-time>

ISO 8601 timestamp of creation

​
settings
object

Campaign configuration settings

​
coreVariables
object

Core variables enabled for this campaign

​
customVariables
object

Custom variables defined for this campaign

​
linkedinAccounts
string[]

Array of LinkedIn account IDs associated with the campaign

​
analytics
object