v1

latestSwagger 2.02026-07-134026156.7 KB
Templates

Add new fields to a Template

Adds fields to a PDF template. Configure field types, positions, defaults, and formatting options.

put/templates/{template_id}/add_fields

Path parameters

template_idstring required

Request body

Example request

{
  "fields": [
    {
      "name": "new_field1",
      "page": 1
    },
    {
      "name": "new_field2",
      "page": 1,
      "type": "string",
      "displayType": "text",
      "rotation": 10,
      "overflow": "truncate",
      "default": "default text"
    },
    {
      "name": "new_field3",
      "page": 2,
      "type": "number",
      "integer": true,
      "displayType": "text",
      "rotation": 0
    },
    {
      "name": "new_field4",
      "page": 3,
      "type": "number",
      "integer": true,
      "displayType": "text",
      "rotation": 0
    },
    {
      "name": "new_field5",
      "id": 99,
      "page": 2,
      "x": 20,
      "y": 60,
      "width": 150,
      "height": 50,
      "type": "number",
      "integer": true,
      "displayType": "text",
      "rotation": 0
    },
    {
      "name": "first_name",
      "page": 1,
      "x": 40,
      "y": 60,
      "width": 150,
      "height": 50,
      "type": "number",
      "integer": true,
      "displayType": "text",
      "rotation": 0,
      "minimum": 10,
      "maximum": 100,
      "description": "updated description for existing field"
    }
  ]
}

Response

add fields success

status'success' | 'error' required
errorsstring[]
new_field_idsinteger[]