Skip to main content
POST
/
api
/
v1
/
campaigns
/
{campaign_id}
/
leads
/
{campaign_lead_id}
/
approve
Approve Lead Email
curl --request POST \
  --url https://api.example.com/api/v1/campaigns/{campaign_id}/leads/{campaign_lead_id}/approve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "step_index": 16,
  "variant_label": "<string>",
  "subject": "<string>",
  "body": "<string>",
  "custom_prompt": "<string>",
  "prompt_snapshot": "<string>",
  "model": "<string>",
  "generation_latency_ms": 1,
  "research_sources": "<unknown>",
  "expected_step_config_fingerprint": "<string>"
}
'
import requests

url = "https://api.example.com/api/v1/campaigns/{campaign_id}/leads/{campaign_lead_id}/approve"

payload = {
    "step_index": 16,
    "variant_label": "<string>",
    "subject": "<string>",
    "body": "<string>",
    "custom_prompt": "<string>",
    "prompt_snapshot": "<string>",
    "model": "<string>",
    "generation_latency_ms": 1,
    "research_sources": "<unknown>",
    "expected_step_config_fingerprint": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    step_index: 16,
    variant_label: '<string>',
    subject: '<string>',
    body: JSON.stringify('<string>'),
    custom_prompt: '<string>',
    prompt_snapshot: '<string>',
    model: '<string>',
    generation_latency_ms: 1,
    research_sources: '<unknown>',
    expected_step_config_fingerprint: '<string>'
  })
};

fetch('https://api.example.com/api/v1/campaigns/{campaign_id}/leads/{campaign_lead_id}/approve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/campaigns/{campaign_id}/leads/{campaign_lead_id}/approve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'step_index' => 16,
    'variant_label' => '<string>',
    'subject' => '<string>',
    'body' => '<string>',
    'custom_prompt' => '<string>',
    'prompt_snapshot' => '<string>',
    'model' => '<string>',
    'generation_latency_ms' => 1,
    'research_sources' => '<unknown>',
    'expected_step_config_fingerprint' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/campaigns/{campaign_id}/leads/{campaign_lead_id}/approve"

	payload := strings.NewReader("{\n  \"step_index\": 16,\n  \"variant_label\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"custom_prompt\": \"<string>\",\n  \"prompt_snapshot\": \"<string>\",\n  \"model\": \"<string>\",\n  \"generation_latency_ms\": 1,\n  \"research_sources\": \"<unknown>\",\n  \"expected_step_config_fingerprint\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/campaigns/{campaign_id}/leads/{campaign_lead_id}/approve")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"step_index\": 16,\n  \"variant_label\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"custom_prompt\": \"<string>\",\n  \"prompt_snapshot\": \"<string>\",\n  \"model\": \"<string>\",\n  \"generation_latency_ms\": 1,\n  \"research_sources\": \"<unknown>\",\n  \"expected_step_config_fingerprint\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/campaigns/{campaign_id}/leads/{campaign_lead_id}/approve")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"step_index\": 16,\n  \"variant_label\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"body\": \"<string>\",\n  \"custom_prompt\": \"<string>\",\n  \"prompt_snapshot\": \"<string>\",\n  \"model\": \"<string>\",\n  \"generation_latency_ms\": 1,\n  \"research_sources\": \"<unknown>\",\n  \"expected_step_config_fingerprint\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaign_lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z",
  "step_index": 123,
  "approved_steps": [
    123
  ],
  "approved_entry": {
    "subject": "<string>",
    "body": "<string>",
    "prompt_snapshot": "<string>",
    "prompt_version_hash": "<string>",
    "lead_identity_fingerprint": "<string>",
    "step_index": 123,
    "variant_label": "<string>",
    "step_config_fingerprint": "<string>",
    "approved_at": "2023-11-07T05:31:56Z",
    "approved_by": "<string>",
    "research_cache_fingerprint": "<string>",
    "sender_profile_id": "<string>",
    "template_id": "<string>",
    "model": "<string>",
    "generation_latency_ms": 123
  }
}

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.