643 matches
25 actions
API v1
25 actions
- Add new fields to a TemplatePUTv1.0.0
- Check the status of a combined submission (merged PDFs)GETv1.0.0
- Check the status of a PDFGETv1.0.0
- Copy a TemplatePOSTv1.0.0
- Create a folderPOSTv1.0.0
- Create a new HTML templatePOSTv1.0.0
- Delete a folderDELETEv1.0.0
- Expire a combined submissionDELETEv1.0.0
- Expire a PDF submissionDELETEv1.0.0
- Fetch the full template attributesGETv1.0.0
- Generates a new PDFPOSTv1.0.0
- Get a list of all combined submissionsGETv1.0.0
- Get a list of all foldersGETv1.0.0
- Get a list of all templatesGETv1.0.0
- List all submissionsGETv1.0.0
- List all submissions for a given templateGETv1.0.0
- Look up a submission data requestGETv1.0.0
- Merge generated PDFs togetherPOSTv1.0.0
- Merge submission PDFs, template PDFs, or custom filesPOSTv1.0.0
- Move a folderPOSTv1.0.0
- Move Template to folderPOSTv1.0.0
- Rename a folderPOSTv1.0.0
- Test AuthenticationGETv1.0.0
- Update a submission data requestPUTv1.0.0
- Update a TemplatePUTv1.0.0
Other/API v1
Add new fields to a Template
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
- 330
- 331
- 332
- 333
- 334
- 335
- 336
- 337
- 338
- 339
- 340
- 341
- 342
- 343
- 344
- 345
- 346
- 347
- 348
- 349
- 350
- 351
- 352
- 353
- 354
- 355
- 356
- 357
- 358
- 359
- 360
- 361
- 362
- 363
- 364
{
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"page"
],
"properties": {
"alignment": {
"type": "string",
"enum": [
"left",
"center",
"right"
]
},
"autoCalculateMaxLength": {
"type": "boolean"
},
"backgroundColor": {
"type": "string"
},
"backgroundColorFieldName": {
"type": "string"
},
"backgroundColorFieldRequired": {
"type": "boolean"
},
"barcodeSymbology": {
"type": "string"
},
"bold": {
"type": "boolean"
},
"characterSpacing": {
"type": "number"
},
"checkCharacter": {
"type": "string",
"enum": [
"✓",
"✔",
"✖",
"✗",
"✘"
]
},
"checkColor": {
"type": "string"
},
"checkColorFieldName": {
"type": "string"
},
"checkColorFieldRequired": {
"type": "boolean"
},
"color": {
"type": "string"
},
"colorFieldName": {
"type": "string"
},
"colorFieldRequired": {
"type": "boolean"
},
"comb": {
"type": "boolean"
},
"combNumberOfCells": {
"type": "number"
},
"combValueOffset": {
"type": "number"
},
"combinedFieldFormat": {
"type": "string"
},
"combinedFieldNames": {
"type": "string"
},
"combinedFieldSeparator": {
"type": "string"
},
"combinedFieldType": {
"type": "string"
},
"condition": {
"type": "string"
},
"currency": {
"type": "boolean"
},
"dateTimeFormat": {
"type": "string"
},
"decimalPlaces": {
"type": "number"
},
"default": {
"type": "string"
},
"description": {
"type": "string"
},
"displayType": {
"type": "string",
"enum": [
"text",
"check",
"qrcode",
"barcode",
"image",
"shape"
]
},
"exclusiveMaximum": {
"type": "boolean"
},
"exclusiveMinimum": {
"type": "boolean"
},
"falseText": {
"type": "string"
},
"fontSize": {
"type": "number"
},
"height": {
"type": "number"
},
"hidden": {
"type": "boolean"
},
"id": {
"type": "number"
},
"imageGravity": {
"type": "string",
"enum": [
"NorthWest",
"North",
"NorthEast",
"West",
"Center",
"East",
"SouthWest",
"South",
"SouthEast"
]
},
"imageScaleType": {
"type": "string",
"enum": [
"fit",
"fill",
"stretch"
]
},
"includeTime": {
"type": "boolean"
},
"integer": {
"type": "boolean"
},
"invertBooleanCondition": {
"type": "boolean"
},
"maxLength": {
"type": "number"
},
"maximum": {
"type": "number"
},
"metadata": {
"type": "string"
},
"minLength": {
"type": "number"
},
"minimum": {
"type": "number"
},
"multiline": {
"type": "boolean"
},
"multilineLines": {
"type": "number"
},
"name": {
"type": "string"
},
"numberConditionRangeExclusiveMax": {
"type": "boolean"
},
"numberConditionRangeExclusiveMin": {
"type": "boolean"
},
"numberConditionRangeMax": {
"type": "number"
},
"numberConditionRangeMin": {
"type": "number"
},
"numberConditionType": {
"type": "string",
"enum": [
"equals",
"range",
"gte",
"gt",
"lte",
"lt"
]
},
"opacity": {
"type": "number"
},
"optionList": {
"type": "string"
},
"overflow": {
"type": "string",
"enum": [
"shrink_to_fit",
"truncate"
]
},
"page": {
"type": "number"
},
"placeholder": {
"type": "string"
},
"qrcodeColor": {
"type": "string"
},
"qrcodeColorFieldName": {
"type": "string"
},
"qrcodeColorFieldRequired": {
"type": "boolean"
},
"required": {
"type": "boolean"
},
"rotation": {
"type": "number"
},
"shapeBorderColor": {
"type": "string"
},
"shapeBorderColorFieldName": {
"type": "string"
},
"shapeBorderColorFieldRequired": {
"type": "boolean"
},
"shapeBorderWidth": {
"type": "number"
},
"shapeFillColor": {
"type": "string"
},
"shapeFillColorFieldName": {
"type": "string"
},
"shapeFillColorFieldRequired": {
"type": "boolean"
},
"shapeType": {
"type": "string",
"enum": [
"square",
"rectangle",
"circle",
"ellipse"
]
},
"signatureAllowDraw": {
"type": "boolean"
},
"signatureAllowType": {
"type": "boolean"
},
"static": {
"type": "boolean"
},
"strikethrough": {
"type": "boolean"
},
"stringConditionType": {
"type": "string",
"enum": [
"equals",
"contains",
"starts_with",
"ends_with",
"regex"
]
},
"title": {
"type": "string"
},
"trueText": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"string",
"number",
"boolean",
"date",
"address",
"country",
"email",
"url",
"image",
"signature",
"barcode",
"combined"
]
},
"typeface": {
"type": "string"
},
"uppercase": {
"type": "boolean"
},
"vAlignment": {
"type": "string",
"enum": [
"bottom",
"center",
"top"
]
},
"width": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
}
},
"template_id": {
"type": "string"
}
},
"required": [
"fields",
"template_id"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
{
"type": "object",
"required": [
"status"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
},
"new_field_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"status": {
"type": "string",
"enum": [
"success",
"error"
]
}
}
}