Skip to main content
POST
Atualizar um monitor

Autorizações

pubrio-api-key
string
header
obrigatório

Um token de API exclusivo que representa as ações que você realiza por meio da API e as permissões e operações correspondentes. Você pode criá-lo na seção Configurações.

Corpo

application/json
monitor_id
string<uuid>
obrigatório

Identificador único do monitor a atualizar.

name
string

Nome do monitor.

description
string

Descrição do monitor.

detection_mode
enum<string>

Como os sinais são detectados. signal_first varre o mercado de forma ampla; company_first acompanha uma lista de contas nomeadas e exige ao menos uma empresa, domínio ou URL do LinkedIn. Imutável após a criação — alterá-lo em um monitor existente retorna 40021. Crie um novo monitor em vez disso.

Opções disponíveis:
company_first,
signal_first
signal_types
enum<string>[]

Tipos de sinais a monitorar.

Opções disponíveis:
jobs,
news,
advertisements,
expansions,
cloud_footprints
signal_filters
object[]

Uma entrada por fluxo de sinal que o monitor observa.

Exemplo:
company_filters
object

Filtros globais de empresa aplicados como uma segunda camada em todos os tipos de sinal. Aceita os mesmos parâmetros do endpoint Company Search — localizações, número de funcionários, tecnologias, verticais e mais.

Exemplo:
companies
string<uuid>[]

Lista de UUIDs de domain_search_id de empresas. Alternativa: use domains ou linkedin_urls.

domains
string[]

Lista de domínios de empresas. Alternativa a companies.

linkedin_urls
string<uri>[]

Lista de URLs de empresas no LinkedIn. Alternativa a companies.

is_company_enrichment
boolean

Se deve enriquecer dados de empresa.

is_people_enrichment
boolean

Se deve enriquecer dados de pessoas.

people_enrichment_configs
object[]

Array de camadas de enriquecimento de pessoas. Cada camada executa uma busca de pessoas independente. Contém max_people_to_return (1-25), people_contact_types (array — refere-se aos tipos de contato de Redeem: email-work, email-personal, phone) e filters (mesmos parâmetros do endpoint People Search).

Exemplo:
destination_type
enum<string>

Tipo de destino de entrega.

Opções disponíveis:
webhook,
email,
sequences
destination_config
object

Configuração do destino. Para webhook: exige webhook_url (string), com headers (objeto) e body (objeto) opcionais. Para email: aceita email (string) ou emails (array de strings). Para sequences: exige sequence_identifier (string) mais ao menos um de is_people_search_enrolled / is_company_contact_enrolled definido como true.

Exemplo:
frequency_minute
integer

Frequência de acionamento em minutos. Mín: 0, Máx: 10080, Padrão: 0.

Intervalo necessário: 0 <= x <= 10080
max_failure_trigger
integer

Número máximo de falhas consecutivas antes de pausar. Mín: 1, Máx: 10, Padrão: 5.

Intervalo necessário: 1 <= x <= 10
max_daily_trigger
integer

Número máximo de acionamentos por dia. Mín: 0, Máx: 86400, Padrão: 500.

Intervalo necessário: 0 <= x <= 86400
max_records_per_trigger
integer

Controla o número máximo de registros entregues por acionamento. Valores menores reduzem o tamanho do payload por entrega, o que é recomendado para conjuntos de resultados grandes ou integrações com limite de taxa. Mín: 1, Máx: 100, Padrão: 25. Veja Setting up Webhooks para orientações.

Intervalo necessário: 1 <= x <= 100
excluded_companies
string[]

Empresas que este monitor nunca entrega nem fatura, como UUIDs domain_search_id. Aplicado em ambos os modos de detecção em tempo de execução, antes do enriquecimento e da faturação; uma empresa presente em companies e nesta lista fica excluída enquanto permanecer na lista. Tamanho máximo: 100.000 (ids resolvidos entre excluded_companies, excluded_domains e excluded_linkedin_urls).

Exemplo:
excluded_domains
string[]

Domínios de empresa a excluir (ex.: ["existing-client.com"]). Resolvidos para empresas e mesclados em excluded_companies.

Exemplo:
excluded_linkedin_urls
string[]

URLs de empresa do LinkedIn a excluir. Resolvidas para empresas e mescladas em excluded_companies.

Exemplo:
companies_mode
enum<string>

Como os companies / domains / linkedin_urls enviados se aplicam à lista de acompanhamento salva: replace (padrão) substitui a lista inteira, add acrescenta as empresas enviadas, remove as retira. Listas omitidas nunca são tocadas.

Opções disponíveis:
replace,
add,
remove
Exemplo:

"add"

excluded_companies_mode
enum<string>

O mesmo para a lista de exclusão (excluded_companies / excluded_domains / excluded_linkedin_urls): replace (padrão), add ou remove.

Opções disponíveis:
replace,
add,
remove
Exemplo:

"add"

record_unit
enum<string>

O que é um registro entregue: signal (payload signals[], uma entrada por sinal) ou company (payload companies[], uma entrada por empresa com seus sinais aninhados). O padrão segue detection_mode: signal_first → signal, company_first → company. Os limites (max_records_per_trigger, max_daily_records) contam esta unidade.

Opções disponíveis:
signal,
company
Exemplo:

"company"

company_dedupe_days
integer

Uma empresa aparece em no máximo uma entrega a cada tantos dias, em todos os tipos de sinal do monitor; uma empresa entregue dentro da janela fica fora das entregas seguintes e seus sinais seguintes dentro da janela são ignorados, não enfileirados. 0 = desligado. Padrão: 0.

Intervalo necessário: x >= 0
Exemplo:

30

is_newest_first
boolean

Entregar primeiro os sinais correspondentes mais recentes. Com um limite por disparo ou diário, os registros mais novos são mantidos e o cursor do monitor avança mesmo assim até a linha mais nova buscada, então linhas antigas são ignoradas, nunca enfileiradas. Padrão false (mais antigos primeiro, nada ignorado).

Exemplo:

true

max_daily_records
integer

Limite rígido de registros entregues por dia civil no fuso do proprietário (0 = ilimitado). Contado na unidade de registro do monitor sobre entregas bem-sucedidas; um disparo entrega no máximo o orçamento restante e depois o monitor aguarda o dia seguinte sem mover seu cursor. Padrão: 0.

Intervalo necessário: x >= 0
Exemplo:

200

notification_email
string<email>

E-mail para notificações de falha.

max_retry_per_trigger
integer

Número máximo de novas tentativas por acionamento. Mín: 0, Máx: 3, Padrão: 1.

Intervalo necessário: 0 <= x <= 3
retry_delay_second
integer

Intervalo entre novas tentativas, em segundos. Mín: 1, Máx: 5, Padrão: 1.

Intervalo necessário: 1 <= x <= 5
status
enum<string>

Status do ciclo de vida a definir. Alterar o status reinicia o contador de falhas.

Opções disponíveis:
draft,
active,
paused,
inactive

Resposta

Resposta bem-sucedida contendo o monitor atualizado. A resposta sempre inclui monitor_id, name, detection_mode, destination_type, status, masked_signature e last_modified, além de quaisquer outras colunas que faziam parte da atualização.

metadata
object
data
object

O monitor atualizado. Quaisquer outras colunas incluídas na atualização também são retornadas.

Última modificação em 4 de setembro de 2026