Outreach API

View and manage AI-generated outreach campaigns for qualified visitors.

Required Headers

Header	Description
`x-access-key`	Your Warm AI API key

Outreach Workflow

Visitor Identified → ICP Qualified → AI Generates Message → User Sends via App

When a visitor qualifies for an ICP, an outreach campaign is automatically created. Warm AI’s AI engine researches the prospect and drafts personalized messages for your review.

List Outreach Campaigns

GET https://api.warmai.uk/outreach-list

Retrieve outreach campaigns for a given website.

Query Parameters

Parameter	Type	Required	Description
`website_id`	string	Yes	The website ID to retrieve outreach campaigns for
`status`	string	No	Filter by campaign status (see below)
`sender_id`	string	No	Filter by sender user ID
`limit`	integer	No	Number of results to return (default `100`)
`offset`	integer	No	Number of results to skip for pagination

Campaign Status Values

Status	Description
`pending`	Awaiting prospect research
`ready`	Draft message is ready for review
`in_progress`	Messages are being sent
`completed`	All messages have been sent
`failed`	Campaign generation or delivery failed

Message Statuses

Status	Description
`pending`	Message is being generated
`draft`	Message is ready for review
`approved`	Message has been approved for sending
`sent`	Message has been sent
`failed`	Message delivery failed
`rejected`	Message was rejected by the user

Response Fields

Field	Type	Description
`outreaches`	array	List of outreach campaign objects
`outreaches[].id`	string	Unique outreach campaign ID
`outreaches[].target_type`	string	`individual` or `company`
`outreaches[].target_linkedin_url`	string	LinkedIn URL of the outreach target
`outreaches[].status`	string	Campaign status
`outreaches[].messages`	array	List of outreach messages
`outreaches[].messages[].message_type`	string	Type of message (e.g. `linkedin_connection`, `linkedin_message`, `email`)
`outreaches[].messages[].sequence_order`	integer	Order in the outreach sequence
`outreaches[].messages[].status`	string	Message status (see table above)
`outreaches[].messages[].content`	string	The message content
`outreaches[].recipient`	object	Recipient details
`outreaches[].sender`	object	Sender details
`outreaches[].icp_name`	string	Name of the matched ICP

Example Request


curl -X GET "https://api.warmai.uk/outreach-list?website_id=ws_a1b2c3d4&status=ready&limit=10" \
  -H "x-access-key: YOUR_API_KEY"

Example Response


{
  "outreaches": [
    {
      "id": "out_r1s2t3",
      "target_type": "individual",
      "target_linkedin_url": "https://linkedin.com/in/janedoe",
      "status": "ready",
      "messages": [
        {
          "message_type": "linkedin_connection",
          "sequence_order": 1,
          "status": "draft",
          "content": "Hi Jane, I noticed you've been exploring visitor identification solutions. As VP of Marketing at Acme Corp, you might find our AI-powered approach interesting — we help teams like yours turn anonymous traffic into qualified pipeline. Would love to connect."
        },
        {
          "message_type": "linkedin_message",
          "sequence_order": 2,
          "status": "pending",
          "content": "Thanks for connecting, Jane! I wanted to share a quick case study on how a similar SaaS company increased their outbound reply rates by 3x using Warm AI's identification and scoring engine. Would you be open to a 15-minute chat this week?"
        }
      ],
      "recipient": {
        "name": "Jane Doe",
        "title": "VP of Marketing",
        "company": "Acme Corp",
        "linkedin_url": "https://linkedin.com/in/janedoe"
      },
      "sender": {
        "id": "user_abc123",
        "name": "Philip Smith",
        "linkedin_url": "https://linkedin.com/in/philipsmith"
      },
      "icp_name": "Enterprise Marketing Leaders"
    }
  ]
}