Skip to main content
POST
Batch preview (SSE) — up to 25 leads, streams results as they complete

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Batch preview request body. Streams results as SSE.

client_run_id
string
required

Client-generated UUIDv4; backend echoes it as batch_id in every event.

leads
BatchPreviewLead · object[]
required
Minimum array length: 1
sender_profile_id
string | null

Saved sender profile id; takes precedence over sender_data.

sender_data
Sender Data · object | null

Inline sender profile data; ignored if sender_profile_id is set.

active_prompt_name
string | null

Name of a named prompt stored on sender_data.prompts[]. Silent fallback to custom_prompt → default if not found.

custom_prompt
string | null

Optional prompt override for this batch run (100-5000 chars).

Response

Successful Response