Update a document template

POST

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

POST

/app/api/v1/document-templates/update/:id

$ curl -X POST https://ssuccessv2.com/app/api/v1/document-templates/update/42 \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Emergency Contact Form 2026",
>   "description": "Updated annual emergency contact form",
>   "fields": [
>     {
>       "type": "tag",
>       "x": 0.18,
>       "y": 0.32,
>       "width": 0.42,
>       "height": 0.04,
>       "fontSize": 11,
>       "fontFamily": "Arial",
>       "page": 1,
>       "id": 101,
>       "value": null,
>       "merge_tag_id": 27
>     }
>   ]
> }'

1 {
2   "status": "success",
3   "message": "Document template updated successfully.",
4   "data": {
5     "id": 42,
6     "name": "Emergency Contact Form 2026",
7     "description": "Updated annual emergency contact form",
8     "entity_type": "student",
9     "created_at": {},
10     "updated_at": {},
11     "fields": []
12   }
13 }

Updates the template name or description and, when supplied, replaces its interactive form fields.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired

Document template identifier.

Request

This endpoint expects an object.

namestringOptional<=255 characters

descriptionstring or nullOptional<=1000 characters

fieldslist of objectsOptional

Response

Updated template returned.

Errors

404

Not Found Error

422

Unprocessable Entity Error