Email a contract to its recipients

POST

https://ssuccessv2.com/app/api/v1/contract/email

Queues contract PDFs for the selected contract's parents, optionally using selected payers or a test email address.

AuthorizationBearer

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

This endpoint expects an object.

contract_idintegerRequired>=1

send_emailbooleanRequired

include_previous_years_balanceboolean or nullOptional

previous_years_balance_typeenum or nullOptional

Allowed values:

payerslist of stringsOptional

send_test_emailstringOptionalformat: "email"

document_layoutenumOptionalDefaults to combined

Allowed values:

Email jobs queued for one or more recipients.

statusstringOptional

messagestringOptional

dataobjectOptional

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/contract/email \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"contract_id": 642,
>	"send_email": true,
>	"include_previous_years_balance": true,
>	"previous_years_balance_type": "due_amount",
>	"payers": [],
>	"send_test_email": "family@example.com",
>	"document_layout": "combined"
>	}'

1	{
2	"status": "success",
3	"message": "Contract emails queued for delivery.",
4	"data": {
5	"notifications_count": 2,
6	"total_recipients": 2,
7	"errors_count": 0,
8	"errors": []
9	}
10	}