Create Campaign

Creates a new outreach campaign

POST /campaigns

Create Campaign

cURL

curl --request POST \
  --url https://api.kakiyo.com/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Q2 Sales Outreach",
  "productId": "prod_123456789",
  "promptId": "prompt_987654321",
  "agentId": "agent_abcdef123456",
  "qualificationAutomatic": 75,
  "qualificationVerification": 50,
  "variables": {
    "companyValue": "Our AI-powered sales enablement platform",
    "painPoint": "low response rates on cold outreach",
    "benefit": "3x more qualified meetings"
  },
  "preventAutoStart": false
}
'

201

{
  "id": "campaign_12345abcde",
  "name": "Q2 Sales Outreach",
  "status": "active",
  "preventAutoStart": false
}

Overview

Create a new LinkedIn outreach campaign with AI-powered automation. This endpoint sets up a complete campaign with specified products, prompts, and agents, ready to start prospecting.

Use Cases

• New Product Launch: Create campaigns for new product introductions
• Market Expansion: Set up campaigns for new geographic markets
• Seasonal Campaigns: Launch time-sensitive promotional campaigns
• A/B Testing: Create multiple campaigns to test different approaches
• Delayed Launch: Create campaigns early (with preventAutoStart: true), upload leads, and launch later when ready

Key Features

• AI-Powered Messaging: Automated message generation using specified prompts
• Smart Qualification: Automatic prospect qualification based on responses
• Agent Assignment: Dedicated LinkedIn agents for authentic outreach
• Performance Tracking: Built-in analytics and conversion tracking
• Prevent Auto-Start: Optionally keep campaigns paused through lead uploads until you manually resume

Testing Example

curl -X POST "https://api.kakiyo.com/v1/campaigns" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q4 Enterprise Outreach",
    "productId": "prod_123456789",
    "promptId": "prompt_987654321",
    "agentId": "agent_abcdef123456",
    "variables": {
      "company_name": "Your Company",
      "value_proposition": "20% increase in sales efficiency"
    }
  }'

# Create a campaign that stays paused until manually resumed
curl -X POST "https://api.kakiyo.com/v1/campaigns" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Delayed Launch Campaign",
    "productId": "prod_123456789",
    "promptId": "prompt_987654321",
    "agentId": "agent_abcdef123456",
    "variables": {},
    "preventAutoStart": true
  }'

// JavaScript/Node.js
const createCampaign = async (campaignData) => {
  const response = await fetch('https://api.kakiyo.com/v1/campaigns', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(campaignData)
  });

  return await response.json();
};

// Usage example
// Create campaign (starts active immediately)
const newCampaign = await createCampaign({
  name: 'Q4 Enterprise Outreach',
  productId: 'prod_123456789',
  promptId: 'prompt_987654321',
  agentId: 'agent_abcdef123456',
  variables: {
    company_name: 'Your Company',
    value_proposition: '20% increase in sales efficiency'
  }
});

// Create campaign that stays paused until manually resumed
const delayedCampaign = await createCampaign({
  name: 'Delayed Launch Campaign',
  productId: 'prod_123456789',
  promptId: 'prompt_987654321',
  agentId: 'agent_abcdef123456',
  variables: {},
  preventAutoStart: true
});

console.log('Campaign Created:', newCampaign);

# Python
import requests

def create_campaign(campaign_data):
    """Create a new LinkedIn outreach campaign"""
    response = requests.post(
        'https://api.kakiyo.com/v1/campaigns',
        json=campaign_data,
        headers={
            'Authorization': 'Bearer YOUR_API_KEY',
            'Content-Type': 'application/json'
        }
    )

    return response.json()

# Usage example
campaign_data = {
    'name': 'Q4 Enterprise Outreach',
    'productId': 'prod_123456789',
    'promptId': 'prompt_987654321',
    'agentId': 'agent_abcdef123456',
    'variables': {
        'company_name': 'Your Company',
        'value_proposition': '20% increase in sales efficiency'
    }
}

result = create_campaign(campaign_data)
print('Campaign Created:', result)

# Create campaign that stays paused until manually resumed
delayed_campaign = create_campaign({
    'name': 'Delayed Launch Campaign',
    'productId': 'prod_123456789',
    'promptId': 'prompt_987654321',
    'agentId': 'agent_abcdef123456',
    'variables': {},
    'preventAutoStart': True
})
print('Delayed Campaign:', delayed_campaign)

Prevent Auto-Start

By default, campaigns become active immediately and start outreach as soon as leads are uploaded. If you need to build campaigns ahead of time and launch later:

1. Set preventAutoStart: true when creating the campaign
2. Upload your leads — the campaign stays paused
3. When ready, call POST /campaigns/{id}/resume to activate

Resuming also clears the preventAutoStart flag, so subsequent uploads behave normally.

Best Practices

1. Descriptive Names: Use clear, descriptive campaign names
2. Variable Planning: Define all necessary variables before campaign creation
3. Agent Capacity: Ensure assigned agents have available capacity
4. Testing: Create test campaigns before launching to large prospect lists
5. Delayed Launch: Use preventAutoStart: true for campaigns you want to prepare in advance

Next Steps

After creating a campaign:

1. Add Prospects: Use /prospects or /prospects/batch endpoints
2. Monitor Performance: Check campaign analytics regularly
3. Optimize Settings: Adjust qualification thresholds based on results
4. Scale Gradually: Start with smaller prospect lists and scale up

Authorizations

Authorization · string · header · required

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

Body

application/json

Campaign to create

name · string · required

Required string length: 3 - 100

Example:

"Q2 Sales Outreach"

productId · string · required

Example:

"prod_123456789"

promptId · string · required

Example:

"prompt_987654321"

agentId · string · required

Example:

"agent_abcdef123456"

qualificationAutomatic · integer · default: 70

Required range: 0 <= x <= 100

Example:

75

qualificationVerification · integer · default: 50

Required range: 0 <= x <= 100

Example:

50

variables · object

Example:

{
  "companyValue": "Our AI-powered sales enablement platform",
  "painPoint": "low response rates on cold outreach",
  "benefit": "3x more qualified meetings"
}

preventAutoStart · boolean · default: false

If true, campaign starts paused and stays paused after lead uploads until manually resumed. Defaults to false (immediate auto-activation).

Example:

false

Response

201

application/json

Campaign created successfully

id · string

Example:

"campaign_12345abcde"

name · string

Example:

"Q2 Sales Outreach"

status · string

Example:

"active"

preventAutoStart · boolean

Example:

false