Skip to content
OpenGTM

Generate Outreach

POST
/api/campaigns/generate
curl --request POST \
  --url http://localhost:8000/api/campaigns/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "extra_context": "", "lead_ids": [ 1 ], "tone": "professional", "value_proposition": "example" }'

Generate personalized outreach emails for the given lead IDs.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
x-workspace-id
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
GenerateRequest
object
extra_context
Extra Context
string
""
lead_ids
required
Lead Ids
Array<integer>
tone
Tone
string
default: professional
value_proposition
required
Value Proposition
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
GenerateResponse
object
emails
required
Emails
Array<object>
GeneratedEmail
object
body
required
Body
string
company
required
Company
string
subject
required
Subject
string
Examplegenerated
{
  "emails": [
    {
      "body": "example",
      "company": "example",
      "subject": "example"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}