Skip to main content
POST
Approve Lead Email

Authorizations

Authorization
string
header
required

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

Path Parameters

campaign_id
string<uuid>
required
campaign_lead_id
string<uuid>
required

Body

application/json

POST /campaigns/{id}/leads/{lead_id}/approve body.

step_index
integer
required

Step number being approved (1-indexed, matches steps_config).

Required range: 1 <= x <= 32
variant_label
string
required

Variant label being approved; must match the lead's assigned variant for this step.

Required string length: 1 - 10
subject
string
required

Approved subject line (frozen).

Required string length: 1 - 998
body
string
required

Approved body (frozen).

Required string length: 1 - 50000
custom_prompt
string | null

If provided, overrides the resolved prompt hierarchy for this approval.

Maximum string length: 32000
prompt_snapshot
string | null

Exact prompt text used to generate the draft. If omitted, server resolves it.

Maximum string length: 32000
model
string | null

LLM model identifier used for the draft (e.g., 'gemini-2.0-flash').

generation_latency_ms
integer | null

Optional: generation latency for observability.

Required range: x >= 0
research_sources
any

Optional: research-cache source contents used to produce the draft. Hashed into research_cache_fingerprint.

expected_step_config_fingerprint
string | null

Optional: fingerprint the client computed at draft time. If it differs from the server-computed fingerprint, approval fails with 422 — the step variant/sender/template was swapped after drafting.

Response

Successful Response

POST approve/unapprove/reset response.

campaign_id
string<uuid>
required
campaign_lead_id
string<uuid>
required
updated_at
string<date-time>
required
step_index
integer | null
approved_steps
integer[]

All step indices currently approved for this lead after the operation.

approved_entry
ApprovedEmailEntry · object | null

One entry in campaign_leads.metadata.approved_emails.