mirlo

Cuentas

Gestionar cuentas/empresas y vincular contactos

Endpoints

MetodoRutaDescripcion
GET/crm/organizations/{organization_id}/accountsListar cuentas
POST/crm/organizations/{organization_id}/accountsCrear una cuenta
GET/crm/organizations/{organization_id}/accounts/:idObtener cuenta por ID
PATCH/crm/organizations/{organization_id}/accounts/:idActualizar cuenta
DELETE/crm/organizations/{organization_id}/accounts/:idEliminar cuenta (soft delete)

Crear cuenta

POST /crm/organizations/{organization_id}/accounts

Body

CampoTipoRequeridoDescripcion
namestringSiNombre de la empresa
typestringNoTipo: enterprise, smb, startup, etc.
domainstringNoDominio web (ej: acme.com)
propertiesobjectNoPropiedades personalizadas (JSON libre)

Ejemplo

curl -X POST https://api.mirlo.com/v1/crm/organizations/{organization_id}/accounts \
  -H "X-API-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corporation",
    "type": "enterprise",
    "domain": "acme.com",
    "properties": {
      "industry": "Telecomunicaciones",
      "employees": 150
    }
  }'

Respuesta

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Acme Corporation",
  "type": "enterprise",
  "domain": "acme.com",
  "properties": {
    "industry": "Telecomunicaciones",
    "employees": 150
  },
  "created_at": "2026-07-06T00:00:00.000Z"
}

Listar cuentas

GET /crm/organizations/{organization_id}/accounts

Query Parameters

ParametroTipoDescripcion
limitnumberMaximo de resultados (default: 100)
offsetnumberOffset para paginacion

Actualizar cuenta

PATCH /crm/organizations/{organization_id}/accounts/:id

Todos los campos son opcionales. Solo se actualizan los campos enviados.


Eliminar cuenta

DELETE /crm/organizations/{organization_id}/accounts/:id

Soft delete — la cuenta se marca como eliminada.

En esta pagina