Crafting Outreach

Generate outreach

The outreach endpoint generates a message grounded in real evidence from the prospect's public filings and earnings calls. Every request consumes 1 credit.

curl -X POST https://dealsurface.com/api/v1/outreach \
  -H "Authorization: Bearer $DEALSURFACE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": 12,
    "ticker": "TRV",
    "platform": "email",
    "tone": "helpful"
  }'

Platform and tone

Choose the platform and tone that match your outreach strategy:

You can also control length with shorter, typical (default), or longer.

Targeting a specific stakeholder

There are three ways to personalize outreach for a specific contact:

1. Pass the full stakeholder object

If you already have a stakeholder from the /dealmap endpoint, pass it directly:

{
  "product_id": 12,
  "ticker": "TRV",
  "platform": "email",
  "tone": "helpful",
  "selected_lead": {
    "full_name": "Jane Smith",
    "title": "Chief Information Officer",
    "level": "c_suite",
    "linkedin_url": "https://linkedin.com/in/janesmith"
  }
}

2. Use a lead selector

Let the API resolve the best stakeholder from the cached DealMap:

{
  "product_id": 12,
  "ticker": "TRV",
  "platform": "email",
  "tone": "helpful",
  "lead_selector": { "level": "c_suite" }
}

{
  "product_id": 12,
  "ticker": "TRV",
  "platform": "email",
  "tone": "helpful",
  "lead_selector": { "full_name": "Jane Smith", "level": "c_suite" }
}

{
  "product_id": 12,
  "ticker": "TRV",
  "platform": "email",
  "tone": "helpful",
  "lead_selector": { "stakeholder_role": "Economic Buyer" }
}

3. No lead targeting

Omit both fields to generate generic outreach for the company without personalizing for a specific contact.

Verifying evidence sources

The response includes used_excerpt_ids — the evidence excerpts that grounded the message. Cross-reference with the excerpts endpoint to verify the claims in the generated copy.