What is a release notes?

Versioned list of what's new, improved and fixed, written in user-benefit language with any action required. It is written for Customers, customer-facing teams (support, success, sales). Most teams produce one every two weeks.

How do I generate a release notes PDF from JSON?

Send a POST to /api/v1/generate with your API key, the template id and a JSON body shaped like the sample on this page; DocuJSON renders the release notes and returns the PDF. The same template is callable from the DocuJSON MCP server inside Claude, Cursor or your own agent.

What data does the release notes template need?

The JSON body has 10 top-level keys: productName, version, releaseDate, releaseType, summary, highlights, changes, knownIssues and 2 more. The document reads them into 7 sections, in order: Header, Summary, Highlights, Table: Changes by category, Known issues, Action required, Footer.

Which designs does the release notes template come in?

Five, all free: base, ledger, instrument, rail, form. The same JSON body renders in all of them, so you can switch the design of your release notes without changing your integration.

Is the release notes template free?

Yes. Every template and every design is free, with a small DocuJSON watermark on the free plan. Pro removes the watermark, puts your logo where the DocuJSON mark sits in the release notes preview, and unlocks configurable variables and higher volume.

template · Product · biweekly · Letter portrait

release notes template: json in, branded pdf out

Versioned list of what's new, improved and fixed, written in user-benefit language with any action required.

use this template →generate it from code all templates

five designs, one json body

base · Fraunces + Inter Tightuse this design →

the docujson house design: serif titles, clean tables, KPI cards, navy accents.

what's inside

the sections of the document, in reading order.

01Header
02Summary
03Highlights
04Table: Changes by category
05Known issues
06Action required
07Footer

cadence: biweekly
for: Customers, customer-facing teams (support, success, sales)

the json body

10 keys

every key the document reads. send this shape, get the pdf.

productNamestringproduct name
versionstringversion
releaseDatestringrelease date
releaseTypestringrelease type
summarystringsummary
highlightsarrayhighlights · 2 items
changesarraychanges · 6 items
knownIssuesarrayknown issues · 1 item
actionRequiredstringaction required
linksobjectlinks

built-in logic

A clean structure the engine lays out in any of the five designs; send the JSON and the document follows.

configurable outputs · pro

pro

one template. many outputs.

Set these once per template, in the workspace, no code. Every request then lays out by the rules you chose: the same data, a different document.

on every template

Signature blocks
Date format
Currency
Page orientation

configure it in the workspace →

the same data, three ways

signature blocks: off

page orientation: landscape

generate it from your code

01Pick a designChoose one of the five release notes designs; base and ledger are free.
02Send your JSONPOST a body shaped like the sample (productName, version, releaseDate, releaseType…) to /api/v1/generate with your API key, or call the template from the MCP server.
03Get the PDFDocuJSON renders the release notes with your logo and returns the PDF; the template id stays stable as you iterate.

Use this template in the builder, publish it, and you get a stable templateId for the API and the MCP server.

curl -X POST https://api.docujson.com/v1/generate \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "templateId": "<your-template-id>", "data": { ... } }'

also: the `generate_pdf` tool on mcp.docujson.com, from Claude, Cursor or your own agent.

questions, answered

What is a release notes?: Versioned list of what's new, improved and fixed, written in user-benefit language with any action required. It is written for Customers, customer-facing teams (support, success, sales). Most teams produce one every two weeks.
How do I generate a release notes PDF from JSON?: Send a POST to /api/v1/generate with your API key, the template id and a JSON body shaped like the sample on this page; DocuJSON renders the release notes and returns the PDF. The same template is callable from the DocuJSON MCP server inside Claude, Cursor or your own agent.
What data does the release notes template need?: The JSON body has 10 top-level keys: productName, version, releaseDate, releaseType, summary, highlights, changes, knownIssues and 2 more. The document reads them into 7 sections, in order: Header, Summary, Highlights, Table: Changes by category, Known issues, Action required, Footer.
Which designs does the release notes template come in?: Five, all free: base, ledger, instrument, rail, form. The same JSON body renders in all of them, so you can switch the design of your release notes without changing your integration.
Is the release notes template free?: Yes. Every template and every design is free, with a small DocuJSON watermark on the free plan. Pro removes the watermark, puts your logo where the DocuJSON mark sits in the release notes preview, and unlocks configurable variables and higher volume.

your release notes, from json, in one call.

free to start. you land on this template when you sign up.

use this template →