mirlo

Miembros

Gestionar los miembros (agentes) de tu organizacion

Los miembros representan a los agentes de tu equipo que atienden conversaciones. Pueden ser humanos o agentes de IA.

Listar Miembros

curl -X GET "https://api.mirlo.com/v2/messages/organizations/{organization_id}/members" \
  -H "X-API-Key: sk_live_tu_api_key"

Parametros de Query

ParametroTipoDescripcion
skipnumberRegistros a saltar (paginacion). Default: 0
takenumberRegistros a retornar. Default: 20

Response

[
  {
    "id": "agent_3b7d9216-6a76-411f-b5a8-597b43730cd2",
    "organization_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "name": "Maria Garcia",
    "picture": "https://example.com/avatar.jpg",
    "ai": false,
    "extra": {
      "role": "agent",
      "department": "ventas"
    },
    "created_at": "2025-11-15T10:30:00.000Z",
    "updated_at": "2026-01-20T15:45:00.000Z"
  },
  {
    "id": "agent_ai_001",
    "organization_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "name": "Asistente IA",
    "ai": true,
    "extra": {},
    "created_at": "2025-10-01T08:00:00.000Z",
    "updated_at": "2025-10-01T08:00:00.000Z"
  }
]

Obtener un Miembro

curl -X GET "https://api.mirlo.com/v2/messages/organizations/{organization_id}/members/{member_id}" \
  -H "X-API-Key: sk_live_tu_api_key"

Crear un Miembro

curl -X POST "https://api.mirlo.com/v2/messages/organizations/{organization_id}/members" \
  -H "X-API-Key: sk_live_tu_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Carlos Lopez",
    "ai": false,
    "organization_id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "picture": "https://example.com/carlos.jpg",
    "extra": {
      "department": "soporte"
    }
  }'

Campos del Body

CampoTipoRequeridoDescripcion
namestringSiNombre del miembro
aibooleanSitrue para agentes de IA, false para humanos
organization_idUUIDSiID de la organizacion
idstringNoID personalizado. Si no se envia, se genera automaticamente
user_idUUIDNoID del usuario asociado (para vinculacion con sistema de auth)
picturestringNoURL de la foto de perfil
extraobjectNoDatos adicionales en formato JSON

Actualizar un Miembro

curl -X PATCH "https://api.mirlo.com/v2/messages/organizations/{organization_id}/members/{member_id}" \
  -H "X-API-Key: sk_live_tu_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Carlos Lopez Actualizado",
    "picture": "https://example.com/carlos-new.jpg"
  }'

Todos los campos son opcionales en la actualizacion. Solo se modifican los campos enviados.

Eliminar un Miembro

curl -X DELETE "https://api.mirlo.com/v2/messages/organizations/{organization_id}/members/{member_id}" \
  -H "X-API-Key: sk_live_tu_api_key"

Eliminar un miembro no reasigna automaticamente sus conversaciones activas. Asegurate de reasignar o archivar las conversaciones del miembro antes de eliminarlo.


Asignar Miembro a una Conversacion

Para asignar un miembro a una conversacion, usa el endpoint de actualizar conversacion:

curl -X PATCH "https://api.mirlo.com/v2/messages/organizations/{organization_id}/conversations/{conversation_id}" \
  -H "X-API-Key: sk_live_tu_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "extra": {
      "member_id": "agent_3b7d9216-6a76-411f-b5a8-597b43730cd2"
    }
  }'

Referencia de Endpoints

Todos bajo https://api.mirlo.com/v2/messages/organizations/{organization_id}

MetodoEndpointDescripcion
GET.../membersListar miembros
GET.../members/{id}Obtener un miembro
POST.../membersCrear un miembro
PATCH.../members/{id}Actualizar un miembro
DELETE.../members/{id}Eliminar un miembro

En esta pagina