Skip to main content
GET
/
api
/
public
/
v1
/
campaigns
/
{campaign_id}
/
leads
/
upload
/
{job_id}
Get upload progress
curl --request GET \
  --url https://api.coldsend.pro/api/public/v1/campaigns/{campaign_id}/leads/upload/{job_id} \
  --header 'X-API-Key: <api-key>'
{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "progress_percentage": 123,
  "processed_count": 123,
  "success_count": 123,
  "duplicate_count": 123,
  "error_count": 123,
  "total_count": 123,
  "errors": [
    {}
  ],
  "blocked_count": 0,
  "blocked_entries": [
    {}
  ],
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-Key
string
header
required

API key with format cs_live_xxx

Path Parameters

​
campaign_id
string<uuid>
required
​
job_id
string<uuid>
required

Response

Upload progress retrieved

Response for lead upload progress tracking.

​
job_id
string<uuid>
required

Job ID

​
campaign_id
string<uuid>
required

Campaign ID

​
status
string
required

Job status (PENDING, VALIDATING, IN_PROGRESS, COMPLETED, FAILED)

​
progress_percentage
integer
required

Progress percentage (0-100)

​
processed_count
integer
required

Number of rows processed

​
success_count
integer
required

Number of valid leads created

​
duplicate_count
integer
required

Number of duplicate emails found

​
error_count
integer
required

Number of invalid rows

​
total_count
integer
required

Total rows in CSV

​
errors
Errors · object[]
required

Detailed error information for failed rows

​
blocked_count
integer
default:0

Number of rows skipped because they matched the team blocklist

​
blocked_entries
Blocked Entries · object[]

Per-row blocklist hits. Each entry has email_address, block_type ('email'|'domain') and blocked_value.

​
started_at
string<date-time> | null
​
completed_at
string<date-time> | null