Queue a multi-contract export

POST

https://ssuccessv2.com/app/api/v1/contracts/export

Queues a PDF or ZIP export for contracts selected by IDs, a single contract, or a registration batch. Completion is delivered through SchoolSet notifications.

Authentication

AuthorizationBearer

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

Request

This endpoint expects any.

anyRequired

Response

Export queued.

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/contracts/export \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"batch_id": 2025,
>	"registration_phase_id": 7,
>	"mode": "zip",
>	"include_previous_years_balance": true,
>	"previous_years_balance_type": "due_amount",
>	"document_layout": "combined"
>	}'

1	{
2	"status": "success",
3	"message": "Processing... Once complete",
4	"data": {
5	"queued": true,
6	"mode": "zip"
7	},
8	"you will receive an email with the file.": null
9	}