Skip to main content
POST
Enrich a draft before confirmation

Authorizations

Authorization
string
header
required

API key issued with npm run partner-api:key. Format: rg_live_....

Body

application/json
companyName
string
required
Required string length: 1 - 200
companyWebsite
string<uri>
required
founders
object[]
required
Required array length: 1 - 10 elements
thingsToTrack
string
required

Natural-language alert rules, compiled into a governed policy.

Required string length: 1 - 10000
alertEmails
string<email>[]
required
Required array length: 1 - 20 elements
companyLinkedinUrl
string<uri>
companyTwitterUrl
string<uri>
companyGithubUrl
string<uri>
companySummary
string
Maximum string length: 5000
emailAlertsEnabled
boolean
default:true
cadenceDays
enum<integer>
default:7
Available options:
3,
7,
30

Response

Enriched draft. Send data to POST /api/v1/tracker with confirmed: true to track it.

data
object
requiresConfirmation
boolean
missingProfiles
string[]