Reten Docs
Actividades

Crear Actividad

Crear una nueva actividad asignada a un comercio.

POST /api/activities

Crea una nueva actividad TASK con asignación de comercio.

Auth: Requerida — permiso CREATE_ACTIVITY

Cuerpo de la Solicitud

CampoTipoRequeridoDescripción
typestringTASK
reasonstringRazón para crear la actividad
channelstringSALESMAN, CALLCENTER
commerce_idUUIDID del comercio objetivo
idempotency_keystringClave única por tenant (evita duplicados)
scheduled_atISO 8601Cuándo debe ejecutarse la actividad
suggested_execution_timeISO 8601NoTiempo sugerido para la ejecución
user_statusstringNoContexto de estado del usuario
scoreintegerNoPuntuación de prioridad
assignment_reasonstringNoRazón de la asignación
activity_detailsobjectNoDetalles específicos del tipo — la forma depende de type (ver abajo)

activity_details

Para type: "TASK", el objeto activity_details lleva la asignación de ruta/operador:

CampoTipoRequeridoDescripción
assigned_route_idUUIDNoRuta asignada
assigned_route_external_idstringNoRuta asignada por ID externo
assigned_operator_idUUIDNoOperador asignado
assigned_operator_external_idstringNoOperador asignado por ID externo

Ejemplo

curl -X POST https://api.reten.ai/api/activities \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "TASK",
    "reason": "monthly_visit",
    "channel": "SALESMAN",
    "commerce_id": "880e8400-e29b-41d4-a716-446655440000",
    "idempotency_key": "task-2025-01-15-001",
    "scheduled_at": "2025-01-16T09:00:00.000Z",
    "activity_details": {
      "assigned_route_id": "dd0e8400-e29b-41d4-a716-446655440000",
      "assigned_operator_id": "cc0e8400-e29b-41d4-a716-446655440000"
    }
  }'
const response = await fetch("https://api.reten.ai/api/activities", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "x-tenant-id": "<tenant-id>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    type: "TASK",
    reason: "monthly_visit",
    channel: "SALESMAN",
    commerce_id: "880e8400-e29b-41d4-a716-446655440000",
    idempotency_key: "task-2025-01-15-001",
    scheduled_at: "2025-01-16T09:00:00.000Z",
    activity_details: {
      assigned_route_id: "dd0e8400-e29b-41d4-a716-446655440000",
      assigned_operator_id: "cc0e8400-e29b-41d4-a716-446655440000",
    },
  }),
});
const activity = await response.json();
import requests

response = requests.post(
    "https://api.reten.ai/api/activities",
    headers={
        "Authorization": "Bearer <token>",
        "x-tenant-id": "<tenant-id>",
    },
    json={
        "type": "TASK",
        "reason": "monthly_visit",
        "channel": "SALESMAN",
        "commerce_id": "880e8400-e29b-41d4-a716-446655440000",
        "idempotency_key": "task-2025-01-15-001",
        "scheduled_at": "2025-01-16T09:00:00.000Z",
        "activity_details": {
            "assigned_route_id": "dd0e8400-e29b-41d4-a716-446655440000",
            "assigned_operator_id": "cc0e8400-e29b-41d4-a716-446655440000",
        },
    },
)
activity = response.json()

Respuesta 201 Created

Una actividad TASK nace en READY y queda lista para despacharse de inmediato: la identidad del comercio asignado es lo único que el despacho necesita. Ver Activity States para el catálogo completo.

{
  "id": "ee0e8400-e29b-41d4-a716-446655440000",
  "type": "TASK",
  "reason": {
    "code": "monthly_visit",
    "label": "Visita Mensual"
  },
  "channel": "SALESMAN",
  "status": "READY",
  "userStatus": null,
  "idempotencyKey": "task-2025-01-15-001",
  "scheduledAt": "2025-01-16T09:00:00.000Z",
  "commerceAssignment": {
    "commerceId": "880e8400-e29b-41d4-a716-446655440000"
  }
}

Respuestas de Error

EstadoDescripción
400Error de validación
404Comercio no encontrado
409La clave de idempotencia ya existe