Quickstart

This guide walks you through creating your first client, offer, campaign, and submitting a lead via the API.

Prerequisites

• A LeadSail account with an active organization
• An API key (see API Keys)

Step 1: Create a Client

Clients represent the buyers who will receive your leads. Navigate to Clients in the sidebar and click Add Client.

Provide a name and any relevant contact details. The client will be available to associate with offers and campaigns.

Step 2: Create an Offer

Offers represent what a client is buying leads for. Go to Offers and click Add Offer.

Link the offer to your client and configure the offer category and details.

Step 3: Create a Campaign

Campaigns are the central configuration unit. Navigate to Campaigns and click Create Campaign.

1. Give your campaign a name and select the client and offer
2. Set up a delivery endpoint — where qualified leads will be sent
3. Configure basic routing rules — conditions that determine which leads match this campaign
4. Optionally set delivery limits and schedules

Step 4: Submit a Lead

Use the API to submit a lead:

curl -X POST https://api.leadsail.app/api/v1/leads/submit \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignId": "cmp_your-campaign-id",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "phone": "+15551234567"
  }'

The lead will be routed, qualified, and delivered based on your campaign configuration.

Next Steps

• Authentication — Learn about JWT and API key auth
• Campaigns Overview — Deep dive into campaign configuration
• Lead Lifecycle — Understand lead statuses and flow