Skip to main content
GET
Poll a bulk-delete job

Authorizations

Authorization
string
header
required

Use Authorization: Bearer tc_live_xxxxx

Path Parameters

job_id
string<uuid>
required

The job_id from the 202 response of POST /v1/leads/bulk-delete.

Response

Job status

A background bulk-delete job.

job_id
string<uuid>
required
status
enum<string>
required
Available options:
pending,
running,
completed,
completed_with_skipped,
failed,
canceled
total_leads
integer
required

Leads the filter matched when the job started.

deleted
integer
required

Leads deleted so far.

skipped
integer
required

Leads already gone when their chunk ran.

chunks_done
integer
required

Chunks of 1,000 leads done.

chunks_total
integer
required
error
string | null
required

Why the job failed. Null unless status is failed.

created_at
string<date-time>
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required