Skip to main content

templateElementUpdateInput

Update an existing element on a Template. Same fields as templateElementCreateInput but targets an existing element.

Fields

FieldTypeRequiredDescription
templateElementIdID!YesElement to update
elementTypeString!YesField type (e.g. SIGNATURE, TEXT, DATE, INITIALS)
pageInt!YesPage number
axFloatNoStarting x coordinate
ayFloatNoStarting y coordinate
bxFloatNoEnding x coordinate
byFloatNoEnding y coordinate
signerIntNoSigner index
roleStringNoRole name
labelStringNoField label
labelExtraStringNoAdditional label text
valueStringNoDefault value
helpTextStringNoHelp text shown to signer
fontNameStringNoFont for text display
fontSizeIntNoFont size in pixels
alignStringNoText alignment (left, right, centre)
fieldOrderIntNoField ordering on signing page
optionalBooleanNoWhether the field is optional
hideBorderBooleanNoHide field border
substantiveBooleanNoMark as substantive field
optionsStringNoOptions for dropdown/radio fields
validationIntNoValidation rule to apply
logicGroupStringNoConditional logic group
logicActionIntNoConditional logic action
mapToStringNoMap field to a contact or data source

Example

mutation UpdateElement {
updateTemplateElement(input: {
templateElementId: "ZWxlbS0x"
elementType: "TEXT"
page: 1
ax: 100
ay: 200
bx: 350
by: 230
label: "Updated Label"
})
}

Export This Article

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