Upload a template PDF | SchoolSet

curl -X POST https://app.schoolset.io/app/api/v1/document-templates/upload \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: multipart/form-data" \
     -F file=@template_enrollment_form.pdf \
     -F name="Enrollment Form Template" \
     -F entity_type="student"

{
  "status": "success",
  "message": "Document template uploaded and record created successfully.",
  "data": {
    "id": 1024,
    "name": "Enrollment Form Template",
    "description": "Template used for new student enrollment forms.",
    "entity_type": "student",
    "created_at": "2024-06-10T09:15:00Z",
    "updated_at": "2024-06-10T09:15:00Z",
    "file": {},
    "fields": [
      {
        "id": 501,
        "type": "text",
        "x": 150.5,
        "y": 200.75,
        "width": 300,
        "height": 25,
        "fontSize": 12,
        "fontFamily": "Arial",
        "value": "Student Name",
        "page": 1,
        "merge_tag_id": 301,
        "merge_tag": {},
        "created_at": "2024-06-10T09:15:00Z",
        "updated_at": "2024-06-10T09:15:00Z"
      }
    ]
  }
}

Uploads a PDF document template and creates a template record.

Authentication

AuthorizationBearer

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

Request

This endpoint expects a multipart form containing a file.

filefileRequired

Must be a file. Must not be greater than 10240 kilobytes.

namestringRequired

Must not be greater than 255 characters.

descriptionstring or nullOptional

Must not be greater than 1000 characters.

entity_typeenumRequired

entity type value.

Response

Successful POST response for /api/v1/document-templates/upload.

statusenum

Allowed values:

messagestring

dataobject