Skip to main content

​
Get Your API Key

1

Sign Up

Create your account at YOUR_DEPLOYMENT.lupitor.com
2

Navigate to API Keys

Go to your company’s API Keys page in the dashboard
3

Create New Key

Click “Create API Key” and choose the appropriate scope:
  • Read: View leads and conversations
  • Write: Create and manage leads (includes read access)
4

Save Your Key

Copy your API key immediately - it won’t be shown again!
Store your API key securely. Never commit it to version control or share it publicly.

​
Make Your First Request

Let’s create a lead for your campaign: 
curl -X POST https://YOUR_DEPLOYMENT.lupitor.com/api/v1/leads \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignId": "your_campaign_id",
    "phoneNumber": "+15555551234",
    "metadata": {
      "name": "John Doe",
      "company": "Acme Corp"
    }
  }'

const response = await fetch('https://YOUR_DEPLOYMENT.lupitor.com/api/v1/leads', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    campaignId: 'your_campaign_id',
    phoneNumber: '+15555551234',
    metadata: {
      name: 'John Doe',
      company: 'Acme Corp'
    }
  })
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
    'https://YOUR_DEPLOYMENT.lupitor.com/api/v1/leads',
    headers={
        'x-api-key': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'campaignId': 'your_campaign_id',
        'phoneNumber': '+15555551234',
        'metadata': {
            'name': 'John Doe',
            'company': 'Acme Corp'
        }
    }
)

print(response.json())

​
Expected Response

{
  "success": true,
  "data": {
    "leadId": "jh7abc123xyz"
  },
  "error": null
}
Congratulations! You’ve successfully created your first lead via the API.

​
Next Steps

Authentication

Learn about API key scopes and security

Create Leads

Explore the full lead creation API

Bulk Import

Import multiple leads at once

List Leads

Query and filter your leads