Task Result Types

GET /api/task-result-types

List all global task result types.

Auth: Required — VIEW_ACTIVITIES permission

Example

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

const resultTypes = response.data;

Response `200 OK`

[
  { "id": "uuid", "code": "success", "label": "Exito", "isActive": true },
  { "id": "uuid", "code": "not_home", "label": "No se encontro", "isActive": true },
  { "id": "uuid", "code": "is_closed", "label": "Cerrado", "isActive": true },
  { "id": "uuid", "code": "no_interest", "label": "Sin interes", "isActive": true },
  { "id": "uuid", "code": "rescheduled", "label": "Reagendado", "isActive": true },
  { "id": "uuid", "code": "wrong_address", "label": "Direccion incorrecta", "isActive": true },
  { "id": "uuid", "code": "b2b_purchase", "label": "Compra B2B", "isActive": true },
  { "id": "uuid", "code": "no_answer", "label": "Sin respuesta", "isActive": true },
  { "id": "uuid", "code": "callback_requested", "label": "Solicita devolucion de llamada", "isActive": true },
  { "id": "uuid", "code": "other", "label": "Otro", "isActive": true }
]

POST /api/task-result-types

Create a new global task result type.

Auth: Required — MANAGE_ACTIVITY_CONFIG permission

Request Body

Field	Type	Required	Description
`code`	string	Yes	Unique code
`label`	string	Yes	Display label
`description`	string	No	Description of the result type

Example

curl -X POST https://api.reten.ai/api/task-result-types \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "new_type",
    "label": "New Type"
  }'

import axios from 'axios';

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

Response `201 Created`

PATCH /api/task-result-types/:id

Update a task result type.

Auth: Required — MANAGE_ACTIVITY_CONFIG permission

Request Body

Field	Type	Required	Description
`label`	string	No	Display label
`description`	string	No	Description of the result type
`is_active`	boolean	No	Enable or disable this result type

Example

curl -X PATCH https://api.reten.ai/api/task-result-types/<id> \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Updated Label"
  }'

import axios from 'axios';

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