Skip to main content
POST
companies.signal-rule.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
name
string
required

Your rule name.

Required string length: 1 - 128
question
string
required

Company question with {account} as the company placeholder.

Required string length: 1 - 2000
importance
enum<string>
default:normal

Company-signal importance. Exclude disqualifies companies; high helps find suggested accounts.

Available options:
exclude,
low,
normal,
high
allowCustom
boolean
default:false

Allow a question outside the published templates; default false.

Response

The result

groupName
string
required

Your signal group's display name.

name
string
required

Your signal rule's display name.

question
string
required

The company question being checked; may mention people from public sources.

importance
enum<string>
required

Company-signal importance. Exclude disqualifies companies; high helps find suggested accounts.

Available options:
exclude,
low,
normal,
high
ref
string

Reference to what this call created. Pass it as ref to companies.signal-rule.get, companies.signal-rule.delete.