--- title: "Create document template" method: POST path: "/v2/document-templates" tags: ["Document Templates"] --- # Create document template `POST /v2/document-templates` Create document template ## Request body - object - `name` string, required — Name of the template (must be unique) - `description` string — Description of the template - `allowMultiple` boolean — States if multiple instances of the document template is allowed - `mandatory` boolean — Indicates if the document template is mandatory - `fields` object[] — List of fields and ui elements - `fieldLabel` string, required — Field label - `fieldName` string, required — Field name (Immutable value) - `fieldDescription` string — Field description - `fieldType` 'DROPDOWN' | 'MULTI_SELECT' | 'CHECKBOX' | 'TEXT' | 'TEXT_MULTILINE' | 'TEXT_ENCRYPTED' | 'NUMERIC' | 'DECIMAL' | 'DATE' | 'DATE_TIME' | 'TIME' | 'ATTACHMENT' | 'NODE_DROPDOWN' | 'NODE_MULTI_SELECT' | 'CLIENT_DROPDOWN' | 'CLIENT_MULTI_SELECT' | 'CLIENT_LOCATION_DROPDOWN' | 'CLIENT_LOCATION_MULTI_SELECT' | 'CLIENT_DOCUMENT_DROPDOWN' | 'CLIENT_DOCUMENT_MULTI_SELECT' | 'EMAIL' | 'PHONE' | 'IP_ADDRESS' | 'WYSIWYG' | 'URL' | 'MONETARY' | 'IDENTIFIER' | 'TOTP' — The type of custom field that determines how data is stored and displayed - `fieldTechnicianPermission` 'NONE' | 'EDITABLE' | 'READ_ONLY' | 'ROLE_BASED' — Technician access level for custom fields - `fieldScriptPermission` 'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE' — Script access level for custom fields via automation - `fieldApiPermission` 'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE' — Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves) - `fieldDefaultValue` string — Default value - `fieldContent` object — Field content - `values` object[] — Used for dropdown options - `name` string — Dropdown option name - `required` boolean — Indicates if the field is required - `footerText` string — Footer text - `tooltipText` string — Tooltip text - `advancedSettings` object - `fileMaxSize` integer - `fileExtensions` string[] - `dateFilters` object - `type` 'NONE' | 'INCLUDE' | 'EXCLUDE' | 'PAST_DATES_ONLY' | 'FUTURE_DATES_ONLY' | 'RANGE' — Date filtering options for date/time custom fields - `selected` string[] - `maxCharacters` integer - `complexityRules` object - `mustContainOneInteger` boolean - `mustContainOneLowercaseLetter` boolean - `mustContainOneUppercaseLetter` boolean - `greaterOrEqualThanSixCharacters` boolean - `numericRange` object - `min` number - `max` number - `org` integer[] - `nodeClass` string[] - `ipAddressType` 'ALL' | 'IPV4' | 'IPV6' — IP address validation type for IP address custom fields - `expandLargeValueOnRender` boolean - `identifier` object - `automaticGenerationEnabled` boolean - `scope` 'NONE' | 'GLOBAL' | 'ORGANIZATION' - `assignTo` 'NEW_ASSETS_ONLY' | 'NEW_AND_EXISTING_ASSETS' - `type` 'CUSTOM' | 'SEQUENCE' - `nextSequenceNumber` integer - `prefix` string - `suffix` string - `monetary` object - `currency` 'USD' | 'EUR' | 'CAD' | 'GBP' | 'AUD' | 'JPY' | 'SEK' | 'NOK' | 'DKK' | 'CHF' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHE' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYI' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAD' | 'XAF' | 'XCD' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' - `templates` integer[] - `nodeRole` integer[] - `uiElementName` string — UI element name - `uiElementType` 'TITLE' | 'DESCRIPTION' | 'SEPARATOR' — UI element type - `uiElementValue` string — UI element value - `availableToAllTechnicians` boolean — States if the document template is available to all technicians - `allowedTechnicianRoles` integer[] — List of allowed technician role ids ## Response `200` Returns the document template created - object - `id` integer — Identifier - `name` string — Name of the template (must be unique) - `description` string — Description of the template - `allowMultiple` boolean — Indicates if multiple instances of the document template is allowed - `mandatory` boolean — Indicates if the document template is mandatory - `createTime` number, double — Creation time - `updateTime` number, double — Last updated time - `fields` object[] — Document template fields - `fieldId` integer — Field identifier - `fieldLabel` string — Field or UI element name - `fieldName` string — Field name - `fieldDescription` string — Field description - `fieldType` 'DROPDOWN' | 'MULTI_SELECT' | 'CHECKBOX' | 'TEXT' | 'TEXT_MULTILINE' | 'TEXT_ENCRYPTED' | 'NUMERIC' | 'DECIMAL' | 'DATE' | 'DATE_TIME' | 'TIME' | 'ATTACHMENT' | 'NODE_DROPDOWN' | 'NODE_MULTI_SELECT' | 'CLIENT_DROPDOWN' | 'CLIENT_MULTI_SELECT' | 'CLIENT_LOCATION_DROPDOWN' | 'CLIENT_LOCATION_MULTI_SELECT' | 'CLIENT_DOCUMENT_DROPDOWN' | 'CLIENT_DOCUMENT_MULTI_SELECT' | 'EMAIL' | 'PHONE' | 'IP_ADDRESS' | 'WYSIWYG' | 'URL' | 'MONETARY' | 'IDENTIFIER' | 'TOTP' — The type of custom field that determines how data is stored and displayed - `fieldTechnicianPermission` 'NONE' | 'EDITABLE' | 'READ_ONLY' | 'ROLE_BASED' — Technician access level for custom fields - `fieldScriptPermission` 'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE' — Script access level for custom fields via automation - `fieldApiPermission` 'NONE' | 'READ_ONLY' | 'WRITE_ONLY' | 'READ_WRITE' — Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves) - `fieldDefaultValue` string — Default value - `fieldContent` object — Field content - `values` object[] — Used for dropdown options - `id` string, uuid — Identifier - `name` string — Dropdown option name - `active` boolean — Indicates if a dropdown option is active - `required` boolean — Indicates if the field is required - `footerText` string — Footer text - `tooltipText` string — Tooltip text - `advancedSettings` object - `fileMaxSize` integer - `fileExtensions` string[] - `dateFilters` object - `type` 'NONE' | 'INCLUDE' | 'EXCLUDE' | 'PAST_DATES_ONLY' | 'FUTURE_DATES_ONLY' | 'RANGE' — Date filtering options for date/time custom fields - `selected` string[] - `maxCharacters` integer - `complexityRules` object - `mustContainOneInteger` boolean - `mustContainOneLowercaseLetter` boolean - `mustContainOneUppercaseLetter` boolean - `greaterOrEqualThanSixCharacters` boolean - `numericRange` object - `min` number - `max` number - `org` integer[] - `nodeClass` string[] - `ipAddressType` 'ALL' | 'IPV4' | 'IPV6' — IP address validation type for IP address custom fields - `expandLargeValueOnRender` boolean - `identifier` object - `automaticGenerationEnabled` boolean - `scope` 'NONE' | 'GLOBAL' | 'ORGANIZATION' - `assignTo` 'NEW_ASSETS_ONLY' | 'NEW_AND_EXISTING_ASSETS' - `type` 'CUSTOM' | 'SEQUENCE' - `nextSequenceNumber` integer - `prefix` string - `suffix` string - `monetary` object - `currency` 'USD' | 'EUR' | 'CAD' | 'GBP' | 'AUD' | 'JPY' | 'SEK' | 'NOK' | 'DKK' | 'CHF' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'AOA' | 'ARS' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHE' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYI' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAD' | 'XAF' | 'XCD' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' - `templates` integer[] - `nodeRole` integer[] - `uiElementUid` string, uuid — UI element identifier - `uiElementName` string — UI element name - `uiElementType` 'TITLE' | 'DESCRIPTION' | 'SEPARATOR' — UI element type - `uiElementValue` string — UI element value - `createdTime` number, double — Creation time - `updatedTime` number, double — Last updated time - `availableToAllTechnicians` boolean — Indicates if the document template is available to all technicians - `allowedTechnicianRoles` integer[] — List of allowed technician role ids - `archived` boolean — Indicates if the document template is archived - `archivedTime` number, double — Indicates the time the template was archived - `archivedBy` object — Indicates who archived the template - `id` integer - `displayName` string - `deleted` boolean --- [API](https://skmtc.net/ninjarmm/apis/ninjaone-public-api-2-0.md) · [All operations](https://skmtc.net/ninjarmm/apis/ninjaone-public-api-2-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ninjarmm/ninjaone-public-api-2-0/revisions/753f26d46650/schema)