Register an uploaded PDF as a template

POST

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

POST

/app/api/v1/document-templates/upload

$ curl -X POST https://ssuccessv2.com/app/api/v1/document-templates/upload \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "file_manager_id": 781,
>   "name": "Emergency Contact Form",
>   "entity_type": "student",
>   "description": "Annual emergency contact information form"
> }'

1 {
2   "status": "success",
3   "message": "Document uploaded successfully.",
4   "data": {
5     "id": 42,
6     "name": "Emergency Contact Form",
7     "description": "Annual emergency contact information form",
8     "entity_type": "student",
9     "created_at": {},
10     "updated_at": {},
11     "file": {
12       "id": 781,
13       "file_hash": "6d1f4e8a9c2b",
14       "file_name": "emergency-contact-form.pdf",
15       "file_original_name": "Emergency Contact Form.pdf",
16       "file_mime_type": "application/pdf",
17       "caption": "Emergency Contact Form",
18       "file_size": 184320,
19       "created_at": {},
20       "updated_at": {}
21     },
22     "field_scan": null
23   }
24 }

Associates an already-uploaded PDF file-manager record with a new document template and queues field detection for the active school.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

file_manager_idintegerRequired

Uploaded PDF file-manager identifier.

namestringRequired<=255 characters

entity_typeenumRequired

descriptionstring or nullOptional<=1000 characters

Response

Template created and returned.

Errors

422

Unprocessable Entity Error

500

Internal Server Error