Reten Docs
Resultados de Atividades

Configurações de Tipos de Resultado

Configuração por tenant dos tipos de resultado ativos.

GET /api/task-result-type-configs

Lista todas as configurações de tipos de resultado do tenant.

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

Exemplo

curl https://api.reten.ai/api/task-result-type-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/task-result-type-configs',
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

const configs = response.data;

Resposta 200 OK

[
  {
    "id": "880e8400-e29b-41d4-a716-446655440000",
    "code": "success",
    "label": "✅ Venta",
    "requiresFutureScheduledAt": false,
    "isActive": true,
    "createdAt": "2026-06-18T06:00:00.000Z",
    "updatedAt": "2026-06-18T06:00:00.000Z"
  },
  {
    "id": "990e8400-e29b-41d4-a716-446655440000",
    "code": "decision_maker_unavailable",
    "label": "👤 No se encuentra",
    "requiresFutureScheduledAt": false,
    "isActive": true,
    "createdAt": "2026-06-18T06:00:00.000Z",
    "updatedAt": "2026-06-18T06:00:00.000Z"
  }
]

GET /api/task-result-type-configs/defaults

Retorna os tipos de resultado 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 tipos de resultado 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/task-result-type-configs/bulk. Nada é criado ao chamar este endpoint.

Exemplo

curl https://api.reten.ai/api/task-result-type-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/task-result-type-configs/defaults',
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

const defaults = response.data;

Resposta 200 OK

[
  {
    "code": "success",
    "label": "✅ Venta"
  },
  {
    "code": "decision_maker_unavailable",
    "label": "👤 No se encuentra"
  }
]

POST /api/task-result-type-configs

Cria uma configuração de tipo de resultado para o tenant.

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

Corpo da Requisição

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

Exemplo

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

const response = await axios.post(
  'https://api.reten.ai/api/task-result-type-configs',
  {
    code: 'success',
    label: 'Exito',
  },
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

Resposta 201 Created

POST /api/task-result-type-configs/bulk

Criação em massa de configurações de tipos de resultado 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 tipo de resultado no catálogo do tenant
items[].labelstringSimEtiqueta de exibição para este tenant

Exemplo

curl -X POST https://api.reten.ai/api/task-result-type-configs/bulk \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "code": "success",
        "label": "Exito"
      },
      {
        "code": "no_answer",
        "label": "Sin respuesta"
      }
    ]
  }'
import axios from 'axios';

const response = await axios.post(
  'https://api.reten.ai/api/task-result-type-configs/bulk',
  {
    items: [
      {
        code: 'success',
        label: 'Exito',
      },
      {
        code: 'no_answer',
        label: 'Sin respuesta',
      },
    ],
  },
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

Resposta 201 Created

PATCH /api/task-result-type-configs/:id

Atualiza uma configuração de tipo de resultado 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/task-result-type-configs/<id> \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "is_active": false
  }'
import axios from 'axios';

const response = await axios.patch(
  'https://api.reten.ai/api/task-result-type-configs/<id>',
  {
    is_active: false,
  },
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

Resposta 200 OK

DELETE /api/task-result-type-configs/:id

Desativa uma configuração de tipo de resultado do tenant.

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

Exemplo

curl -X DELETE https://api.reten.ai/api/task-result-type-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/task-result-type-configs/<id>',
  {
    headers: {
      Authorization: 'Bearer <token>',
      'x-tenant-id': '<tenant-id>',
    },
  }
);

Resposta 204 No Content

Criar Resultado de Atividade

Criar o resultado de uma atividade de tarefa.