POST
Criar Monitoramento

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required
Maximum string length: 255

Body

application/json
identifier
string
required
identifier_type
enum<string>
required
Available options:
cpf,
cnpj
name
string
Maximum string length: 255
listen_items
enum<string>[]
Maximum array length: 4
Available options:
company,
debts,
processes,
partners
emails
string<email>[]
Maximum array length: 20
frequency_hours
integer
Required range: 1 <= x <= 720
confirm_extra
boolean

Confirma a contratação quando o limite incluído foi atingido.

Response

Monitoramento criado

id
string<uuid>
required
object
enum<string>
required
Available options:
monitor
status
enum<string>
required
Available options:
active,
paused,
cancelled
identifier
string
required
identifier_type
enum<string>
required
Available options:
cpf,
cnpj
listen_items
enum<string>[]
required
Available options:
company,
debts,
processes,
partners
emails
string<email>[]
required
frequency_hours
integer
required
Required range: 1 <= x <= 720
health
object
required
subscription
object
required
execution_allowed
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
name
string
blocking_reason
enum<string> | null
Available options:
monitor_paused,
monitor_cancelled,
payment_required,
feature_disabled