MosendDeveloper

Broadcasts

Envíos masivos a listas con plantillas. Estados, métricas y cancelación.

Base path: /organizations/:orgId/broadcasts·6 endpoints·Source: mosend-wb-backend/src/modules/broadcasts/broadcasts.controller.ts
GET/organizations/:orgId/broadcasts
bearer

Lista las difusiones (broadcasts) de la organización.

Path params

  • orgIdstringrequerido

Respuestas

  • 200
curl -X GET 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/broadcasts' \
  -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/organizations/:orgId/broadcasts/:id
bearer

Detalle de una difusión, incluyendo conteos agregados (counts: total/sent/delivered/read/failed/replied).

Path params

  • orgIdstringrequerido
  • idstringrequerido

Respuestas

  • 200
curl -X GET 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/broadcasts/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/organizations/:orgId/broadcasts/:id/recipients
bearer

Destinatarios de la difusión, filtrables por estado (para el detalle).

Path params

  • orgIdstringrequerido
  • idstringrequerido

Query params

  • filterstring
  • cursorstring
  • limitstring

Respuestas

  • 200
curl -X GET 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/broadcasts/00000000-0000-0000-0000-000000000000/recipients' \
  -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/organizations/:orgId/broadcasts
bearer

Crea una difusión (DRAFT, o SCHEDULED si pasás scheduledAt). No envía nada todavía.

Path params

  • orgIdstringrequerido

Body

CreateBroadcastInputparámetro: body

Respuestas

  • 201
curl -X POST 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/broadcasts' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"name": "Lanzamiento mayo","phoneNumberId": "00000000-0000-0000-0000-000000000000","templateId": "00000000-0000-0000-0000-000000000000","listId": "00000000-0000-0000-0000-000000000000"}'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Lanzamiento mayo",
    "phoneNumberId": "00000000-0000-0000-0000-000000000000",
    "templateId": "00000000-0000-0000-0000-000000000000",
    "listId": "00000000-0000-0000-0000-000000000000"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
POST/organizations/:orgId/broadcasts/:id/send
bearer

Dispara el envío: resuelve audiencia (dedup + opt-outs), valida cuota y manda. Bloquea hasta terminar.

Path params

  • orgIdstringrequerido
  • idstringrequerido

Respuestas

  • 201
curl -X POST 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/broadcasts/00000000-0000-0000-0000-000000000000/send' \
  -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/organizations/:orgId/broadcasts/:id/cancel
bearer

Cancela una difusión DRAFT/SCHEDULED. Lo ya enviado no se desmanda.

Path params

  • orgIdstringrequerido
  • idstringrequerido

Respuestas

  • 201
curl -X POST 'https://api.mosend.dev/organizations/a1b2c3d4-1234-5678-9abc-def012345678/broadcasts/00000000-0000-0000-0000-000000000000/cancel' \
  -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"
}