Skip to main content
POST
/
api
/
public
/
v1
/
campaigns
/
{campaign_id}
/
leads
Upload leads via CSV
curl --request POST \
  --url https://api.coldsend.pro/api/public/v1/campaigns/{campaign_id}/leads \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form file='@example-file' \
  --form 'mapping=<string>' \
  --form duplicate_action=skip \
  --form delete_existing=false
{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total_rows": 123,
  "estimated_leads": 123,
  "progress_url": "<string>",
  "success": true,
  "message": "Lead upload initiated"
}

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Path Parameters

campaign_id
string<uuid>
required

Query Parameters

Body

multipart/form-data
file
file
required

CSV file with leads

mapping
string
required

JSON mapping from CSV columns to lead fields

duplicate_action
string
default:skip

Action for duplicates: 'skip' or 'update'

delete_existing
boolean
default:false

Delete existing leads before upload

Response

Lead upload initiated

Response for lead upload initiation.

job_id
string<uuid>
required

Job ID for tracking upload progress

campaign_id
string<uuid>
required

Campaign ID

total_rows
integer
required

Total rows in CSV

estimated_leads
integer
required

Estimated valid leads

progress_url
string
required

URL to check upload progress

success
boolean
default:true
message
string
default:Lead upload initiated