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

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

Required string length: 1 - 128

Response

The result

name
string
required

Your signal group's display name.

discoveryMode
enum<string>
required

Whether new account suggestions are disabled, limited or unlimited.

Available options:
disabled,
limited,
unlimited
filters
object
required

The current account suggestion filters.

ref
string

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