Create Contract Email | SchoolSet

Creates contract data from submitted details.

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

This endpoint expects an object.

contract_idslist of integersRequired

contract IDs list.

batch_idinteger or nullOptional

This field is required when none of contract_ids and contract_id are present.

contract_idinteger or nullOptional

This field is required when none of batch_id and contract_ids are present.

include_previous_years_balancebooleanOptional

include previous years balance flag.

previous_years_balance_typeenum or nullOptional

previous years balance type option.

Allowed values:

Successful POST response for /api/v1/contract/email.

statusstring

messagestring

datalist of maps from strings to any

1	curl -X POST https://app.schoolset.io/app/api/v1/contract/email \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"contract_ids": [
6	1024
7	]
8	}'

1	{
2	"status": "success",
3	"message": "Contract emails have been successfully queued for delivery.",
4	"data": [
5	{}
6	]
7	}