Skip to main content
POST
Accept a lead and start tracking

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Body

application/json
thingsToTrack
string
required
alertEmails
string<email>[]
required
Required array length: 1 - 20 elements
emailAlertsEnabled
boolean
default:true
cadenceDays
enum<integer>
default:7
Available options:
3,
7,
30
companyName
string
companyWebsite
string<uri>

Required when the lead has no website.

companyLinkedinUrl
string<uri>
companyTwitterUrl
string<uri>
founders
object[]
Minimum array length: 1

Response

Already tracked (alreadyTracked: true) or the company already existed (existingEntity: true).

data
object
operation
object
leadId
string<uuid>
alreadyTracked
boolean
existingEntity
boolean