API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · sign_templates

Sign Template Schema

Schema-ID
sign_template
Collection
sign_templates
Permissions
  • Lesensign_template_view
  • Anlegensign_template_create
  • Ändernsign_template_edit
  • Löschensign_template_delete

Felder

Sign Template Schema

sign_templates4 Permissions

Reusable envelope template with pre-defined signer roles and field placements

namestringerforderlich

Template name

1–255 Zeichen
descriptionstringoptional

Internal description of the template

max 2000 Zeichennullable
defaultMessagestringoptional

Default message pre-filled when creating an envelope from this template

max 5000 Zeichennullable
defaultExpiryDaysintegeroptional

Default expiry in days from send date

1 – 365nullable
defaultReminderIntervalDaysintegeroptional
1 – 30nullable
signingOrderstringoptional
Werte
PARALLELSEQUENTIAL
Default: "PARALLEL"
allowDeclinebooleanoptional
Default: true
requireSignatureReasonbooleanoptional
Default: false
signerRolesobject[]optional

Named signer roles (filled in when creating an envelope)

Default: []
signerIndexintegererforderlich
≥ 0
roleNamestringerforderlich
1–100 Zeichen
roleDescriptionstringoptional
max 500 Zeichennullable
verificationMethodstringoptional
Werte
EMAIL_LINKSMS_OTPEMAIL_OTPIN_PERSON
Default: "EMAIL_LINK"
defaultEmailemailoptional
max 255 Zeichennullable
defaultNamestringoptional
max 255 Zeichennullable
fieldsobject[]optional
Default: []
fieldIduuidoptional
typestringerforderlich
Werte
SIGNATUREINITIALSTEXTDATECHECKBOXSTAMP
signerIndexintegererforderlich
≥ 0
pageintegererforderlich
≥ 1
xnumbererforderlich
0 – 1
ynumbererforderlich
0 – 1
widthnumbererforderlich
0 – 1
heightnumbererforderlich
0 – 1
requiredbooleanoptional
Default: true
labelstringoptional
max 255 Zeichennullable
placeholderstringoptional
max 255 Zeichennullable
defaultValuestringoptional
max 1000 Zeichennullable
optionsstring[]optional
nullable
characterLimitintegeroptional
≥ 1nullable
dateFormatstringoptional
max 50 Zeichennullable
groupstringoptional
max 100 Zeichennullable
linkedEntityTypestringoptional

Schema ID of the linked entity type this template is designed for

max 100 Zeichennullable
tagsstring[]optional
Default: []
categorystringoptional

Template category for organization and filtering

Werte
GDPRCONTRACTOFFERHRCUSTOM
nullable
isSystemTemplatebooleanoptional

System templates are managed by Codemeta and cannot be deleted

Default: false
variablesobject[]optional

Template variables that are substituted when creating an envelope

Default: []
keystringerforderlich
1–100 Zeichen
labelstringerforderlich
1–255 Zeichen
typestringerforderlich
Werte
TEXTDATENUMBER
requiredbooleanoptional
Default: true
documentIduuidoptional

Default DMS document ID used when creating envelopes from this template

nullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/sign_templates — Liste, paginiert + filterbar
  • GET /api/v1/sign_templates/<id> — Einzelne Entity
  • POST /api/v1/sign_templates — Anlegen
  • PATCH /api/v1/sign_templates/<id> — Teil-Update
  • DELETE /api/v1/sign_templates/<id> — Soft-Delete
  • GET /api/v1/sign_templates/<id>/timeline — Audit + Aktivitäten

Suche