API explorerChangelog
Getting Started

Sections

API explorer
Changelog

Theme switcher

AI Outreach

The AI Outreach endpoint leverages the AI Outreach agent to generate high-conversion, insight-driven sales emails. By analyzing company performance metrics and recipient personas, it crafts personalized messages designed to resonate with specific business pain points.

Possible output fields:

  • subject: AI-optimized subject line.
  • body_html: Full email body in HTML format, containing embedded charts and visual data insights.
  • body_plain: The plain-text version of the generated email content

Customizing Email Content You can control the focus of your email by using the preferred_metrics parameter. To see the full list of available metrics and supported date ranges for each country, use the Describe endpoint: GET /v5/sales-intelligence/emails/outreach/describe

This endpoint uses data credits. 10 credit per email result.

Constraints:

  • start_date and end_date cannot be edited
  • Maximum up to 5 email versions per company/recipient can be generated.

Header Parameters

api-keystring

Body Parameters

companystring Required

Recipient's company name or domain.

recipient_namestring

Recipient name to personalize the outreach email.

Nullable:
True
recipient_titlestring

Recipient title to personalize the outreach email.

Nullable:
True
recipient_emailstring

Recipient email address to send the outreach email.

Nullable:
True
preferred_metricsstring

Preferred metrics to highlight in the outreach email.

Nullable:
True
countrystring

Country code to tailor the outreach email.

Nullable:
True
languagestring

Language code for the outreach email.

Nullable:
True
emails_numberinteger

Number of outreach emails to generate.

formatstring

Format in which the reply should be returned

Enum values:
jsonxml
granularitystring

Time granularity for the returned values

Enum values:
dailyweeklymonthly
start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format

Nullable:
True
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format

Nullable:
True

Response

200
Object
Success

Response Attributes

metaobject

Show child attributes

dataarray
Nullable:
True

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in Claude

Code with AI