Generate an AI email draft for a lead - OutReign Developers

POST

/

email

/

generate

Generate an AI email draft for a lead

curl --request POST \
  --url https://api.outreign.io/rest-api/email/generate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "lead": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_name": "<string>",
    "contact_email": "<string>",
    "company_name": "<string>",
    "job_title": "<string>",
    "company_website": "<string>",
    "industry": "<string>"
  }
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    lead: {
      id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      contact_name: '<string>',
      contact_email: '<string>',
      company_name: '<string>',
      job_title: '<string>',
      company_website: '<string>',
      industry: '<string>'
    }
  })
};

fetch('https://api.outreign.io/rest-api/email/generate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.outreign.io/rest-api/email/generate"

payload = { "lead": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "contact_name": "<string>",
        "contact_email": "<string>",
        "company_name": "<string>",
        "job_title": "<string>",
        "company_website": "<string>",
        "industry": "<string>"
    } }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "email": "<string>",
  "rubric": {},
  "quality_weak": true,
  "research": {},
  "skills_used": [
    "<string>"
  ],
  "error": "<string>",
  "error_code": "<string>"
}

Authorizations

X-API-Key

string

header

required

Create keys in OutReign → Settings → API Keys.

Body

application/json

lead

object

required

Show child attributes

tone

enum<string>

required

Available options:

professional,

friendly,

casual,

formal

goal

enum<string>

required

Available options:

introduction,

follow-up,

meeting,

demo,

proposal,

subject_only,

custom,

trigger_context,

social_proof,

4ts,

elusive,

proximity,

4ps_followup,

4ps_elusive_followup

senderName

string

senderEmail

string

senderCompany

string

businessDescription

string

triggerContext

string

subjectLine

string

customInstruction

string

templateDescription

string

templateValue

string

templateGoal

string

openerWord

string

strict_mode

boolean

variantNum

integer

use4SentenceFramework

boolean

avoidSubjects

string[]

thread

object

Response

Draft

email

string

rubric

object

quality_weak

boolean

research

object | null

skills_used

string[]

error

string

error_code

string

⌘I

Generate an AI email draft for a lead

curl --request POST \
  --url https://api.outreign.io/rest-api/email/generate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "lead": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_name": "<string>",
    "contact_email": "<string>",
    "company_name": "<string>",
    "job_title": "<string>",
    "company_website": "<string>",
    "industry": "<string>"
  }
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    lead: {
      id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      contact_name: '<string>',
      contact_email: '<string>',
      company_name: '<string>',
      job_title: '<string>',
      company_website: '<string>',
      industry: '<string>'
    }
  })
};

fetch('https://api.outreign.io/rest-api/email/generate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.outreign.io/rest-api/email/generate"

payload = { "lead": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "contact_name": "<string>",
        "contact_email": "<string>",
        "company_name": "<string>",
        "job_title": "<string>",
        "company_website": "<string>",
        "industry": "<string>"
    } }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "email": "<string>",
  "rubric": {},
  "quality_weak": true,
  "research": {},
  "skills_used": [
    "<string>"
  ],
  "error": "<string>",
  "error_code": "<string>"
}