Skip to main content
PUT
Edit project template import settings

Authorizations

Authorization
string
header
required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Path Parameters

projectTemplateUid
string
required

Project template UID

Body

application/json

Import settings to apply

android
object
asciidoc
object
autodetectMultilingualFiles
boolean

Try to use multilingual variants for auto-detected CSV and Excel files. Default: true

csv
object
dita
object
doc
object
docBook
object
fileFormat
enum<string>

default: auto-detect

Available options:
auto-detect,
doc,
ppt,
xls,
xlf,
xlf2,
sdlxlif,
ttx,
html,
xml,
mif,
tmx,
idml,
dita,
json,
po,
ts,
icml,
yaml,
properties,
csv,
android_string,
desktop_entry,
mac_strings,
pdf,
windows_rc,
xml_properties,
joomla_ini,
magento_csv,
dtd,
mozilla_properties,
plist,
plain_text,
srt,
sub,
sbv,
wiki,
resx,
resjson,
chrome_json,
epub,
svg,
docbook,
wpxliff,
multiling_xml,
multiling_xls,
mqxliff,
php,
psd,
tag,
md,
vtt
html
object
idml
object

Adobe InDesign (IDML) file import settings.

inputCharset
string
json
object

JSON import settings. contextNotePath, maxLenPath and contextKeyPath use a placeholder path syntax (e.g. ../@context2, @maxlength, ../@context1) to point at a sibling key holding the note/max-length/context-key value for a translatable key: ../ steps up to the translatable key's parent object, then @name addresses the sibling key name there. maxLenPath differs from the other two: its referenced key sits alongside the translatable value itself, not alongside the translatable key one level up, since a max length constrains the value rather than the key.

Configuring contextNotePath/contextKeyPath does NOT automatically exclude the referenced key from translation - it must also be matched by excludeKeyRegexp (or left unmatched by includeKeyRegexp), otherwise it is additionally imported as its own translatable segment.

excludeKeyRegexp/includeKeyRegexp match the full path to a key (e.g. [2]/parent/child/key), not just its bare name - the same slash-separated, [N]-indexed path syntax as contextNotePath/maxLenPath/contextKeyPath, and as the XML file format's contextNoteXpath/maxLenXPath/contextKeyXPath settings.

Example: given

with contextKeyPath=../@context1, contextNotePath=../@context2, maxLenPath=@maxlength and excludeKeyRegexp=.*/(context1|context2|maxlength)$: [0]/key ("Home") and [1]/key ("About") import as plain segments; [2]/parent/child/key ("Hello world") imports with context key greeting_id, context note Shown on the homepage banner and max length 40; [2]/parent/child/context1, .../context2 and .../maxlength are excluded from translation by excludeKeyRegexp - without it they would additionally be imported as their own translatable segments.

mac
object
md
object
mif
object
multilingualCsv
object
multilingualXls
object
multilingualXml
object
outputCharset
string
pdf
object
php
object
po
object
ppt
object
properties
object
psd
object
quarkTag
object
resx
object
sdlXlf
object
segmentationRuleId
integer<int64>
targetLength
boolean

Default: false

targetLengthMax
integer<int32>

default: 1000

targetLengthPercent
boolean

Default: false

targetLengthPercentValue
number<double>

default: 130

targetSegmentationRuleId
integer<int64>
tmMatch
object
ttx
object
txt
object

TXT import settings. Segmentation is fixed at one segment per physical line and cannot be configured via any field of this object.

xlf
object
xlf2
object
xls
object
xml
object
yaml
object
zipCharset
string

Response

OK

android
object
asciidoc
object
autodetectMultilingualFiles
boolean
csv
object
dita
object
doc
object
docBook
object
fileFormat
string
html
object
idml
object

Adobe InDesign (IDML) file import settings.

inputCharset
string
json
object

JSON import settings. contextNotePath, maxLenPath and contextKeyPath use a placeholder path syntax (e.g. ../@context2, @maxlength, ../@context1) to point at a sibling key holding the note/max-length/context-key value for a translatable key: ../ steps up to the translatable key's parent object, then @name addresses the sibling key name there. maxLenPath differs from the other two: its referenced key sits alongside the translatable value itself, not alongside the translatable key one level up, since a max length constrains the value rather than the key.

Configuring contextNotePath/contextKeyPath does NOT automatically exclude the referenced key from translation - it must also be matched by excludeKeyRegexp (or left unmatched by includeKeyRegexp), otherwise it is additionally imported as its own translatable segment.

excludeKeyRegexp/includeKeyRegexp match the full path to a key (e.g. [2]/parent/child/key), not just its bare name - the same slash-separated, [N]-indexed path syntax as contextNotePath/maxLenPath/contextKeyPath, and as the XML file format's contextNoteXpath/maxLenXPath/contextKeyXPath settings.

Example: given

with contextKeyPath=../@context1, contextNotePath=../@context2, maxLenPath=@maxlength and excludeKeyRegexp=.*/(context1|context2|maxlength)$: [0]/key ("Home") and [1]/key ("About") import as plain segments; [2]/parent/child/key ("Hello world") imports with context key greeting_id, context note Shown on the homepage banner and max length 40; [2]/parent/child/context1, .../context2 and .../maxlength are excluded from translation by excludeKeyRegexp - without it they would additionally be imported as their own translatable segments.

mac
object
md
object
mif
object
multilingualCsv
object
multilingualXls
object
multilingualXml
object
outputCharset
string
pdf
object
php
object
po
object
ppt
object
properties
object
psd
object
quarkTag
object
resx
object
sdlXlf
object
segRule
object
targetLength
boolean
targetLengthMax
integer<int32>
targetLengthPercent
boolean
targetLengthPercentValue
number<double>
targetSegRule
object
tmMatch
object
ttx
object
txt
object

TXT import settings. Segmentation is fixed at one segment per physical line and cannot be configured via any field of this object.

xlf
object
xlf2
object
xls
object
xml
object
yaml
object
zipCharset
string