Skip to main content
POST
companies.signal-suggestions.configure

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
ref
string
required

The ref returned by companies.signal-group.create or a row of companies.signal-groups.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
mode
enum<string>
required

Whether new account suggestions are disabled, limited or unlimited.

Available options:
disabled,
limited,
unlimited

Response

The result

mode
enum<string>
required

Whether new account suggestions are disabled, limited or unlimited.

Available options:
disabled,
limited,
unlimited