Skip to main content
POST
companies.account-monitor.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
groupName
string
required

Your signal group's name, as given at creation.

Required string length: 1 - 128
domain
string
required

Company website domain.

status
enum<string>
default:suggested

Start with a free preview, or explicitly activate paid monitoring.

Available options:
suggested,
active

Response

The result

groupName
string
required

Your signal group's display name.

domain
string
required

The monitored company's website domain.

status
enum<string>
required

Suggested accounts are previews; active accounts are monitored; archived accounts retain history.

Available options:
suggested,
active,
archived
company
object

Known company profile fields.

score
number

Company signal score; a suggestion's score is a prediction. Negative scores are possible.

Required range: x <= 100
summary
string

Company signal summary; may mention people from public sources.

lastSignalAt
string

Most recent source publication time, ISO 8601.

ref
string

Reference to what this call created. Pass it as ref to companies.account-monitor.get, companies.account-monitor.update, companies.account-monitor.delete, companies.account-monitor.move.