Generate completed documents

POST

https://ssuccessv2.com/app/api/v1/document-templates/generate

Fills a template for the selected entities. Small jobs download immediately as a PDF or ZIP; jobs exceeding the server page threshold are queued and return a JSON status envelope instead.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Request

This endpoint expects an object.

document_idintegerRequired

entity_idslist of integersOptional

entity_typeenumOptional

output_typeenumOptionalDefaults to auto

Allowed values:

academic_year_idintegerOptional

Response

Either an immediate generated file or a queued generation result.

Errors

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/document-templates/generate \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"document_id": 42,
>	"entity_ids": [
>	1842,
>	1843
>	],
>	"entity_type": "student",
>	"output_type": "auto",
>	"academic_year_id": 7
>	}'