Reten Docs
Configuração de Ciclo de Vida

Configuração de Ciclo de Vida

Acesso somente leitura aos três pilares de ciclo de vida de um Activity Generation Config.

Visão Geral

Uma configuração de ciclo de vida é um dos três pilares que compõem um Activity Generation Config (AGC). Cada pilar classifica uma etapa diferente do ciclo de vida de retenção de um cliente:

PilarRecursoPropósito
activationActivation ConfigsClassifica se (e com que intensidade) um usuário se ativou, com base em momentos de ação iniciais.
engagementEngagement ConfigsAgrupa usuários ativos em níveis de engagement (ex.: casual, core, power).
resurrectionResurrection ConfigsDetecta usuários decaindo para a inatividade e classifica recuperação vs. abandono.

Toda linha de configuração de ciclo de vida sempre pertence a exatamente um AGC (activityGenerationConfigId é NOT NULL, 1:1). Não existe pilar autônomo ou órfão.

Estes recursos são somente leitura. Não existe criação, edição ou exclusão standalone: só existem GET (lista) e GET /:id. Uma configuração de ciclo de vida é criada e editada exclusivamente através do fluxo do AGC — não há templates, não há clone, e não há sourceConfigId/usageType.

Como as configurações de ciclo de vida são criadas e editadas

Você nunca cria nem modifica um pilar diretamente. Em vez disso, os pilares são escritos através dos endpoints do AGC:

Para pré-preencher o assistente de criação do AGC com valores iniciais razoáveis, busque os valores padrão da plataforma em GET /api/lifecycle-defaults.

Autenticação

Todos os endpoints exigem um token JWT Bearer mais o header x-tenant-id identificando o tenant em cujo schema a requisição opera. Os endpoints dos três pilares (activation, engagement e resurrection configs) exigem também o header x-project-id, que identifica o projeto em que a requisição trabalha (veja Autenticação → Contexto de Projeto); GET /api/lifecycle-defaults o ignora.

-H "Authorization: Bearer <token>"
-H "x-tenant-id: <tenant-id>"
-H "x-project-id: <project-id>"

Permissões

PermissãoConcede
lifecycle-config:viewListar e ler os três pilares (ativação / engagement / ressurreição).
activity-generation-config:viewLer o payload de pré-preenchimento dos valores padrão de ciclo de vida.

Convenção de serialização: as três respostas GET dos pilares são camelCase (ex.: sourceTable, userRetentionStatusConfigId). A exceção é GET /api/lifecycle-defaults, cuja resposta é snake_case — é um payload de valores padrão fixo (hardcoded) da plataforma, não uma entidade.

Recursos