Templates / Create

Creates new template..

Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/templates

Method: POST

Authorisation: Minimum role: USER

Request Arguments
Name Type Source
inputDTO_templateBody

  Request body example

Response object

Response status: 200 (OK)

Response type: DTO_template

Wrapper: DTO_response_wrap

Other response statuses: 400 (BadRequest), 403 (Forbidden)

  Response body example

DTO_template
NameTypeReadOnlyDescription
created_byDTO_reference_userReadOnlyCreated by
last_updated_byDTO_reference_userReadOnlyLast updated by
groupsDTO_reference[]Groups
sys_attachmentsDTO_reference_attachment[]Sys attachments
idInt32ReadOnlyId
createdDateTimeReadOnlyCreated
last_updatedDateTimeReadOnlyLast updated
nameStringName
is_defaultBooleanIs default
typeENUM template_typeType
sys_content_richDTO_rich_textSys content rich
DTO_reference_user
NameTypeReadOnlyDescription
profile_picStringReadOnlyProfile pic
emailStringReadOnlyEmail
idInt32Id
labelObjectReadOnlyLabel
DTO_reference
NameTypeReadOnlyDescription
idInt32The id of the reference
labelObjectReadOnlyName/Label from referenced object.
DTO_reference_attachment
NameTypeReadOnlyDescription
size_kbInt32ReadOnlySize kb
statusENUM attachment_statusReadOnlyStatus
status_messageStringReadOnlyStatus message
download_urlStringReadOnlyDownload url
idInt32Id
labelObjectReadOnlyLabel
DTO_rich_text
NameTypeReadOnlyDescription
plain_previewStringReadOnlyPlain preview
htmlStringHtml
editorjsDTO_editorjsEditorjs
tiptapDTO_tiptapTiptap
read_minutesInt32Read minutes
DTO_editorjs
NameTypeReadOnlyDescription
timeInt64Time
versionStringVersion
blocksDTO_editorjs_block[]Blocks
DTO_editorjs_block
NameTypeReadOnlyDescription
idStringId
typeStringType
dataObjectData
DTO_tiptap
NameTypeReadOnlyDescription
typeStringType
contentDTO_tiptap_node[]Content
DTO_tiptap_node
NameTypeReadOnlyDescription
typeStringType
attrsDTO_tiptap_attrsAttrs
contentDTO_tiptap_node[]Content
textStringText
marksDTO_tiptap_mark[]Marks
DTO_tiptap_attrs
NameTypeReadOnlyDescription
textAlignStringTextalign
levelInt32 (nullable)Level
checkedBoolean (nullable)Checked
idInt32 (nullable)Id
altStringAlt
titleStringTitle
widthStringWidth
wrapperStyleStringWrapperstyle
filesDTO_tiptap_file_ref[]Files
hrefStringHref
targetStringTarget
colspanInt32 (nullable)Colspan
rowspanInt32 (nullable)Rowspan
colorStringColor
DTO_tiptap_file_ref
NameTypeReadOnlyDescription
idInt32Id
labelStringLabel
DTO_tiptap_mark
NameTypeReadOnlyDescription
typeStringType
attrsDTO_tiptap_attrsAttrs
ENUM attachment_status
ValueNameDescription
0UNKNOWNUNKNOWN
1UNAVAILABLEUNAVAILABLE, processing in progress
2OKOK
3WARNINGWARNING
4ERRORERROR
ENUM template_type
ValueNameDescription
0UNKNOWNUNKNOWN
1SIGNATURESIGNATURE
2AUTO_REPLYAUTO_REPLY