Skip to main content
POST
Atualizar entidade (refresh)

Visão geral

Reexecuta enrichments do marketplace para pessoa ou empresa existente, opcionalmente:
  • Atualiza nome e/ou entityData (somente se indicado pelos novos flags)
  • Cria ou re-enriquece sócios (empresas, depth > 0)
  • Executa o motor de regras ao concluir
Equivalente programático ao refresh completo do painel (Risk Matrix) ou ao refresh somente dados básicos do Entity Builder.
Retrocompatibilidade: Omitindo refreshScope, preserveName e preserveEntityData, o comportamento permanece o anterior: provedores via autoExecuteIntegrations e nome sincronizado de fullName normalizado quando muda. entityData não é alterado exceto com refreshScope: "basic_data" e preserveEntityData.

Endpoint

Autenticação

Exige permissão para executar enrichments (igual a POST /entities/{entityId}/enrich).

Parâmetros de path

string
required
UUID da entidade a atualizar.

Corpo

boolean
default:"true"
Se true, ignora cache e chama os provedores novamente.
boolean
default:"false"
Se true, não executa regras após o enrichment.
integer
default:"1"
Profundidade de sócios (0–5). Ignorado com refreshScope: "basic_data" (sempre 0).
object
Seleção legacy de provedores (quando refreshScope é omitido). Mesmo formato de POST /entities/automatic.
object
Pipeline de sócios (empresas, depth > 0).
string
Escopo unificado opcional. Quando definido, substitui autoExecuteIntegrations na raiz:
array
Obrigatório quando refreshScope é selected.
boolean
  • true: manter nome atual.
  • false: sincronizar do mapeamento (basic_data) ou fullName normalizado.
  • Omitido (legacy): sincronizar nome se fullName mudou.
boolean
Apenas com refreshScope: "basic_data" e enrichment bem-sucedido:
  • Omitido: não alterar entityData.
  • true: preencher apenas campos vazios (gap-fill).
  • false: substituir entityData pelos dados básicos.
Sem efeito em all_active, selected ou bodies legacy sem basic_data.

Exemplos

Refresh legacy (comportamento inalterado)

Somente dados básicos (seguro)

Resposta

Inclui data.entity, data.enrichmentResult, contadores de sócios e errors. Com skipRulesEngine: false, também rulesExecutionSummary na raiz (como Analyze).

Eventos Socket.IO

entity:refresh-started, entity:refreshed, entity:refresh-failed.

Endpoints relacionados

Analyze

Motor de regras (enrichment opcional).

Materializar relações

Cadeia de sócios a partir do normalized.