Skip to main content
PATCH

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.

Path Parameters

id
string<uuid>
required

Body

application/json
companyName
string
companyWebsite
string<uri>
companyLinkedinUrl
string<uri> | null
companyTwitterUrl
string<uri> | null
companyGithubUrl
string<uri> | null
founders
object[]

Replaces the founder list. Existing founders are matched by id, LinkedIn URL, or name and keep enriched data.

Required array length: 1 - 10 elements
thingsToTrack
string
alertEmails
string<email>[]
emailAlertsEnabled
boolean
cadenceDays
enum<integer>

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

Available options:
3,
7,
30
status
enum<string>
Available options:
ok,
paused
tags
string[]

Normalised: trimmed, lower-cased, de-duplicated and sorted.

Maximum array length: 20

Response

Tracked company plus enrichment operation.

data
object
operation
object
idempotencyReplayed
boolean
existingEntity
boolean