Skip to main content
POST
Create a tracked company

Authorizations

Authorization
string
header
required

API key issued with npm run partner-api:key -- --org <slug> --user <member-email> --name <name>. Format: rg_live_.... The key acts for that member of the organisation; keys of viewer members are read-only.

Headers

Idempotency-Key
string

8-200 printable ASCII characters, no spaces. Remembered for 24 hours.

Required string length: 8 - 200

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
confirmed
boolean
required

Must be true. Explicit confirmation that this company should be tracked.

companyLinkedinUrl
string<uri>
companyTwitterUrl
string<uri>
companyGithubUrl
string<uri>
companySummary
string
Maximum string length: 5000
emailAlertsEnabled
boolean
default:true
cadenceDays
enum<integer>
default:7

Days between tracker runs. Only 3, 7 or 30 are accepted.

Available options:
3,
7,
30

Response

Idempotent replay (idempotencyReplayed: true) or the company was already tracked and updated (existingEntity: true).

data
object
operation
object
idempotencyReplayed
boolean
existingEntity
boolean