Skip to content

Generate Lead Content

POST
/leads/{lead_id}/generate-content

Write a personalised outreach email for one lead (runs a model; billable). Sends nothing.

Authorizations

Parameters

Path Parameters

lead_id
required

Lead id.

integer

Lead id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
agent_name

The writing agent to use.

string
default: default-agent
contact_id
Any of:
integer
instructions
Any of:
string
studio_campaign_id
Any of:
string

Responses

200

Successful Response

object
data
required

Generated content, a batch’s progress, or a removal count.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string