Partners (admin)

Referencia de 10 endpoints generados desde mosend-wb-backend/src/modules/partners/partners.controller.ts.

Base path: /admin·10 endpoints·Source: mosend-wb-backend/src/modules/partners/partners.controller.ts
GET/admin/partners/modulos
bearer

Módulos que un partner puede ocultarles a sus clientes.

Respuestas

  • 200
curl -X GET 'https://api.mosend.dev/admin/partners/modulos' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2026-05-01T03:42:18.123Z"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
GET/admin/partners
bearer

Partners con sus clientes activos y lo que se les cobra al mes.

Respuestas

  • 200
curl -X GET 'https://api.mosend.dev/admin/partners' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'
Response · 200
{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2026-05-01T03:42:18.123Z"
    }
  ],
  "timestamp": "2026-05-01T03:42:18.123Z"
}
GET/admin/partners/:id
bearer

Un partner con sus clientes y sus cobros.

Path params

  • idstringrequerido

Respuestas

  • 200
curl -X GET 'https://api.mosend.dev/admin/partners/00000000-0000-0000-0000-000000000000' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2026-05-01T03:42:18.123Z"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
GET/admin/partners/:id/planes
bearer

Los planes que el partner armó para sus clientes, con su techo.

Path params

  • idstringrequerido

Respuestas

  • 200
curl -X GET 'https://api.mosend.dev/admin/partners/00000000-0000-0000-0000-000000000000/planes' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2026-05-01T03:42:18.123Z"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
POST/admin/partners
bearer

Crea un partner revendedor. Basta la organización y la tarifa: el nombre, el código y quién administra salen solos.

Body (JSON)

  • nombrestring

    Por defecto, el nombre de su organización.

  • codigostring

    Código del enlace de registro. Por defecto, sale del nombre.

  • organizationIdstring · uuid
  • userIdstring · uuid

    Quién administra a los clientes. Por defecto, el dueño de su organización.

  • tarifaPorOrgnumber

    Tarifa mensual por organización de cliente activa. Null = sin cobro.

  • tarifaMonedastring
    COPUSD
  • diaDeCobronumber

    Día del mes (1-28) en que se emite el cobro.

  • modulosBloqueadosstring[]
  • activoboolean
  • notasstring
  • aplicarAClientesboolean

    Al guardar, aplicar los módulos también a los clientes que ya tiene.

Respuestas

  • 201
curl -X POST 'https://api.mosend.dev/admin/partners' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"nombre": "<nombre>","codigo": "<codigo>","organizationId": "00000000-0000-0000-0000-000000000000","userId": "00000000-0000-0000-0000-000000000000","tarifaPorOrg": 0,"tarifaMoneda": "COP","diaDeCobro": 0,"modulosBloqueados": [],"activo": true,"notas": "<notas>","aplicarAClientes": true}'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
PATCH/admin/partners/:id
bearer

Actualiza un partner. Con aplicarAClientes, sus módulos pasan también a los clientes que ya tiene.

Path params

  • idstringrequerido

Body (JSON)

  • nombrestring

    Por defecto, el nombre de su organización.

  • codigostring

    Código del enlace de registro. Por defecto, sale del nombre.

  • organizationIdstring · uuid
  • userIdstring · uuid

    Quién administra a los clientes. Por defecto, el dueño de su organización.

  • tarifaPorOrgnumber

    Tarifa mensual por organización de cliente activa. Null = sin cobro.

  • tarifaMonedastring
    COPUSD
  • diaDeCobronumber

    Día del mes (1-28) en que se emite el cobro.

  • modulosBloqueadosstring[]
  • activoboolean
  • notasstring
  • aplicarAClientesboolean

    Al guardar, aplicar los módulos también a los clientes que ya tiene.

Respuestas

  • 200
curl -X PATCH 'https://api.mosend.dev/admin/partners/00000000-0000-0000-0000-000000000000' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"nombre": "<nombre>","codigo": "<codigo>","organizationId": "00000000-0000-0000-0000-000000000000","userId": "00000000-0000-0000-0000-000000000000","tarifaPorOrg": 0,"tarifaMoneda": "COP","diaDeCobro": 0,"modulosBloqueados": [],"activo": true,"notas": "<notas>","aplicarAClientes": true}'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
POST/admin/partners/:id/clientes
bearer

Asigna una organización existente al partner: pasa a su grupo de facturación (su periodo y su saldo se consolidan en el partner) y a su plan.

Path params

  • idstringrequerido

Body (JSON)

  • organizationIdstring · uuidrequerido

Respuestas

  • 201
curl -X POST 'https://api.mosend.dev/admin/partners/00000000-0000-0000-0000-000000000000/clientes' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"organizationId": "00000000-0000-0000-0000-000000000000"}'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
DELETE/admin/partners/clientes/:organizationId
bearer

Quita la organización de su partner: queda independiente, en el plan gratuito y con su propio saldo.

Path params

  • organizationIdstringrequerido

Respuestas

  • 200
curl -X DELETE 'https://api.mosend.dev/admin/partners/clientes/a1b2c3d4-1234-5678-9abc-def012345678' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2026-05-01T03:42:18.123Z"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
PUT/admin/organizations/:id/modulos-bloqueados
bearer

Módulos que no ven los usuarios de la organización (salvo su partner).

Path params

  • idstringrequerido

Body (JSON)

  • modulosstring[]requerido

Respuestas

  • 200
curl -X PUT 'https://api.mosend.dev/admin/organizations/00000000-0000-0000-0000-000000000000/modulos-bloqueados' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"modulos": []}'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
POST/admin/partners/:id/cobrar
bearer

Emite ya el cobro del mes del partner aunque no haya llegado su día (si ya se emitió, no lo repite).

Path params

  • idstringrequerido

Respuestas

  • 201
curl -X POST 'https://api.mosend.dev/admin/partners/00000000-0000-0000-0000-000000000000/cobrar' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2026-05-01T03:42:18.123Z"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}