Skip to main content
POST
Track a new source

Headers

idempotency-key
string
required

Any client-chosen key, a uuid for example. Sending the same request twice with the same key has one effect and returns the same response twice; the same key with a different body returns 409.

Required string length: 1 - 255
Example:

"3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

Body

application/json
type
enum<string>
required
Available options:
person,
company,
keyword
display_name
string
required
Required string length: 1 - 200
person_id
string
Minimum string length: 1
Example:

"ACoAA…"

company_id
string
Minimum string length: 1
keyword_query
string
Required string length: 1 - 200
source_kind
enum<string>
Available options:
team,
competitor,
influencer,
market
label
string

The workspace's own word for this source. Free text.

Required string length: 1 - 200

Response

The source.

data
object
required