Changelog

API contract versions are taken from info.version in the OpenAPI specification.

Current contract — 0.5.0

CommsPliant Customer Integration API

  • POST /api/v1/render/batches/html — Submit async HTML render batch
  • POST /api/v1/render/batches/pdf — Submit async PDF render batch
  • POST /api/v1/render/html — Render template to HTML (synchronous)
  • GET /api/v1/render/outputs/html/{outputId} — Download one HTML output
  • POST /api/v1/render/outputs/html/download — Download selected HTML outputs as ZIP
  • GET /api/v1/render/outputs/pdf/{outputId} — Download one PDF output
  • POST /api/v1/render/outputs/pdf/download — Download selected PDF outputs as ZIP
  • POST /api/v1/render/pdf — Render template to PDF (synchronous)
  • GET /api/v1/render/processes/{processBatchId}/outputs/html — List HTML outputs for a process
  • GET /api/v1/render/processes/{processBatchId}/outputs/pdf — List PDF outputs for a process