Zum Hauptinhalt springen

templateElementCreateInput

Create a new field or element on a Template page.

Fields​

FieldTypeRequiredDefaultDescription
templateIdID!Yes—Template to add the element to
elementTypeString!Yes—Field type (e.g. SIGNATURE, TEXT)
pageInt!Yes—Page number
axFloatNo0Start X coordinate
ayFloatNo0Start Y coordinate
bxFloatNo0End X coordinate
byFloatNo0End Y coordinate
signerIntNo1Signer index
alignStringNo—Text alignment
fieldOrderIntNo—Tab order
fontNameStringNo—Font name
fontSizeIntNo—Font size
hideBorderBooleanNo—Hide border
labelStringNo—Field label
labelExtraStringNo—Additional label
helpTextStringNo—Help text
optionalBooleanNo—Optional field
optionsStringNo—Dropdown/radio options
roleStringNo—Role name
substantiveBooleanNo—Substantive field
validationIntNo—Validation rule
valueStringNo—Default value
logicGroupStringNo—Logic group
logicActionIntNo—Logic action
mapToStringNo—Map-to identifier
excludeFromPdfBooleanNo—Exclude this field's value from the final PDF

Example​

mutation CreateElement {
createTemplateElement(input: {
templateId: "dHBsLTE="
elementType: "TEXT"
page: 1
ax: 100
ay: 200
bx: 300
by: 230
signer: 1
label: "Full Name"
})
}

Export This Article

Save a copy of this page as PDF or plain text.