Reten Docs
Configuração de Atividades

Configurações de Motivos de Atividade

Configuração por tenant dos motivos de atividade ativos.

GET /api/activity-reason-configs

Lista todas as configurações de motivos de atividade do tenant.

Auth: Obrigatória — permissão activity:view

Exemplo

curl https://api.reten.ai/api/activity-reason-configs \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>"
import axios from 'axios';

const response = await axios.get(
  'https://api.reten.ai/api/activity-reason-configs',
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

const configs = response.data;

Resposta 200 OK

[
  {
    "id": "880e8400-e29b-41d4-a716-446655440000",
    "code": "recurrent",
    "label": "🔁 Reposición de stock",
    "isActive": true,
    "createdAt": "2026-06-18T06:00:00.000Z",
    "updatedAt": "2026-06-18T06:00:00.000Z"
  },
  {
    "id": "990e8400-e29b-41d4-a716-446655440000",
    "code": "retain",
    "label": "❤️ Retención",
    "isActive": true,
    "createdAt": "2026-06-18T06:00:00.000Z",
    "updatedAt": "2026-06-18T06:00:00.000Z"
  }
]

GET /api/activity-reason-configs/defaults

Retorna os motivos de atividade padrão da plataforma como um catálogo plano { code, label }. O app de administração usa isso para pré-preencher o diálogo de importação com os motivos que um tenant pode adotar.

Auth: Obrigatória — permissão activity:view

Este endpoint é de pré-preenchimento, não uma entidade. O payload é o catálogo de defaults fixo no código — não autoritativo e NÃO é persistido — e sempre lista todos os defaults, independentemente do que o tenant já possui. Para adotá-los, o admin escolhe os que ainda faltam e os cria via POST /api/activity-reason-configs/bulk. Nada é criado ao chamar este endpoint.

Exemplo

curl https://api.reten.ai/api/activity-reason-configs/defaults \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>"
import axios from 'axios';

const response = await axios.get(
  'https://api.reten.ai/api/activity-reason-configs/defaults',
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

const defaults = response.data;

Resposta 200 OK

[
  {
    "code": "recurrent",
    "label": "🔁 Reposición de stock"
  },
  {
    "code": "retain",
    "label": "❤️ Retención"
  }
]

POST /api/activity-reason-configs

Cria uma configuração de motivo de atividade para o tenant.

Auth: Obrigatória — permissão activity-config:manage

Corpo da Requisição

CampoTipoObrigatórioDescrição
codestringSimCódigo único que identifica este motivo no catálogo do tenant
labelstringSimEtiqueta de exibição para este tenant

Exemplo

curl -X POST https://api.reten.ai/api/activity-reason-configs \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "retention",
    "label": "Retencion"
  }'
import axios from 'axios';

const response = await axios.post(
  'https://api.reten.ai/api/activity-reason-configs',
  {
    code: 'retention',
    label: 'Retencion',
  },
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

Resposta 201 Created

POST /api/activity-reason-configs/bulk

Criação em massa de configurações de motivos de atividade do tenant.

Auth: Obrigatória — permissão activity-config:manage

Corpo da Requisição

CampoTipoObrigatórioDescrição
itemsarraySimArray de configurações a criar
items[].codestringSimCódigo único que identifica este motivo no catálogo do tenant
items[].labelstringSimEtiqueta de exibição para este tenant

Exemplo

curl -X POST https://api.reten.ai/api/activity-reason-configs/bulk \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "code": "retention",
        "label": "Retencion"
      },
      {
        "code": "upsell",
        "label": "Upsell"
      }
    ]
  }'
import axios from 'axios';

const response = await axios.post(
  'https://api.reten.ai/api/activity-reason-configs/bulk',
  {
    items: [
      {
        code: 'retention',
        label: 'Retencion',
      },
      {
        code: 'upsell',
        label: 'Upsell',
      },
    ],
  },
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

Resposta 201 Created

PATCH /api/activity-reason-configs/:id

Atualiza uma configuração de motivo de atividade do tenant.

Auth: Obrigatória — permissão activity-config:manage

Corpo da Requisição

CampoTipoObrigatórioDescrição
labelstringNãoEtiqueta de exibição
is_activebooleanNãoHabilitar ou desabilitar esta configuração

Exemplo

curl -X PATCH https://api.reten.ai/api/activity-reason-configs/<id> \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Etiqueta Atualizada"
  }'
import axios from 'axios';

const response = await axios.patch(
  'https://api.reten.ai/api/activity-reason-configs/<id>',
  {
    label: 'Etiqueta Atualizada',
  },
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

Resposta 200 OK

DELETE /api/activity-reason-configs/:id

Desativa uma configuração de motivo de atividade do tenant.

Auth: Obrigatória — permissão activity-config:manage

Exemplo

curl -X DELETE https://api.reten.ai/api/activity-reason-configs/<id> \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>"
import axios from 'axios';

const response = await axios.delete(
  'https://api.reten.ai/api/activity-reason-configs/<id>',
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

Resposta 204 No Content

Despachar Atividade de Tarefa

Despachar manualmente uma atividade TASK para um provedor externo.

Configurações de Status de Retenção

Configuração por tenant dos status de retenção de usuário ativos.