Saltar al contenido
ComdigDocs

Referencia de la API

Cancelar un lote

Detiene un lote que está en cola o en proceso. El lote queda en estado stopped.

Solicitud#

POSThttps://api.comdig.co/v1/api-batch-cancel

Permiso requerido: templates:send o bulk:send

Parámetros del cuerpo#

  • batch_idstring (uuid)Requerido

    Identificador que devolvió Envío masivo.

Ejemplo#

Cancelar un lote
curl -X POST "https://api.comdig.co/v1/api-batch-cancel" \
  -H "X-API-Key: $COMDIG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "batch_id": "5a6b7c8d-9e0f-4a1b-8c2d-3e4f5a6b7c8d"
}'

Respuestas#

  • 200Marcado como detenido

    JSON
    {
      "success": true,
      "batch_id": "uuid",
      "status": "stopped"
    }
  • 400Solicitud inválida · invalid_request

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/invalid_request",
      "title": "Solicitud inválida",
      "status": 400,
      "detail": "…",
      "code": "invalid_request"
    }
  • 400Solicitud inválida · batch_not_cancellable

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/batch_not_cancellable",
      "title": "El lote ya terminó",
      "status": 400,
      "detail": "…",
      "code": "batch_not_cancellable"
    }
  • 401Token ausente, inválido, vencido, sin permiso o creador inactivo · invalid_api_key

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/invalid_api_key",
      "title": "Token ausente o inválido",
      "status": 401,
      "detail": "…",
      "code": "invalid_api_key"
    }
  • 401Token ausente, inválido, vencido, sin permiso o creador inactivo · api_key_expired

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/api_key_expired",
      "title": "Token vencido",
      "status": 401,
      "detail": "…",
      "code": "api_key_expired"
    }
  • 401Token ausente, inválido, vencido, sin permiso o creador inactivo · missing_permission

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/missing_permission",
      "title": "El token no tiene el permiso",
      "status": 401,
      "detail": "…",
      "code": "missing_permission"
    }
  • 401Token ausente, inválido, vencido, sin permiso o creador inactivo · token_creator_inactive

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/token_creator_inactive",
      "title": "Quien creó el token ya no es administrador activo",
      "status": 401,
      "detail": "…",
      "code": "token_creator_inactive"
    }
  • 404No encontrado · batch_not_found

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/batch_not_found",
      "title": "Lote no encontrado",
      "status": 404,
      "detail": "…",
      "code": "batch_not_found"
    }
  • 429Límite excedido (rate_limited, o too_many_active_batches en api-send-bulk)

    JSON
    {
      "error": "Demasiadas peticiones: máximo 10 por segundo por token. Reintenta tras Retry-After.",
      "type": "https://docs.comdig.co/errores/rate_limited",
      "title": "Demasiadas peticiones",
      "status": 429,
      "detail": "Demasiadas peticiones: máximo 10 por segundo por token. Reintenta tras Retry-After.",
      "code": "rate_limited"
    }
  • 500Error interno · internal_error

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/internal_error",
      "title": "Error interno",
      "status": 500,
      "detail": "…",
      "code": "internal_error"
    }

Errores#

Además del código HTTP, cada error trae el campo code. Programa tu integración contra él.