Upload a file

post

https://api.lokalise.com/api2/projects/{project_id}:{branch}/files/upload

Queues a localization file for import and returns a 202 or 302 response along with a Queued process object. Learn more. Requires Upload files admin right. Supported file types.

Please note that the 302 response code is not currently used, but in the future it will be returned if the same file is already in the upload queue.

Requires write_files OAuth access scope.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

project_id

string

required

A unique project identifier

branch

string

required

Branch name

Body Params

data

string

required

Base64 encoded file. Must be one of the supported file types.

filename

string

required

Set the filename. You may optionally use a relative path in the filename (e.g admin/main.json), however keep in mind that path would become a unique part of the file. Maximum 256 bytes.

lang_iso

string

required

Language code of the translations in the file you are importing. Must be a language of the project, except for XLIFF files uploaded to Documents projects: there, a user who can manage languages may use any Lokalise language, which is added to the project on import.

convert_placeholders

boolean

Defaults to true

Enable to automatically convert placeholders to the Lokalise universal placeholders. Defaults to true; if omitted, placeholders in the uploaded content are converted automatically. Set it to false to preserve the original placeholder syntax.

detect_icu_plurals

boolean

Defaults to false

Enable to automatically detect and parse ICU formatted plurals in your translations.

tags

tag_inserted_keys

boolean

Defaults to true

Add specified tags to inserted keys. Has no effect if tags is empty.

tag_updated_keys

boolean

Defaults to true

Add specified tags to updated keys. Has no effect if tags is empty.

tag_skipped_keys

boolean

Defaults to false

Add specified tags to skipped keys. Has no effect if tags is empty.

tag_parsed_keys

boolean

Defaults to false

Add tags parsed from the uploaded file (e.g. Structured JSON per-key tags) to the corresponding keys.

replace_modified

boolean

Defaults to false

Enable to replace translations, that have been modified (in the file being uploaded).

replace_metadata

boolean

Defaults to false

Structured JSON only. Enable to replace key metadata (tags, notes, character limit) with the values from the uploaded file. Tags added manually (via the editor, bulk actions, tasks or connectors) are preserved; only tags previously set by a file upload are replaced. Defaults to false.

slashn_to_linebreak

boolean

Defaults to true

Enable to replace \n with a line break.

keys_to_values

boolean

Defaults to false

Enable to automatically replace values with key names.

distinguish_by_file

boolean

Defaults to false

Enable to allow keys with similar names to coexist, in case they are assigned to different filenames.

apply_tm

boolean

Defaults to false

Enable to automatically apply 100% translation memory matches. This option will take priority over use_automations if set to true.

use_automations

boolean

Defaults to true

Whether to run automations for this upload.

hidden_from_contributors

boolean

Defaults to false

Enable to automatically set newly created keys as "Hidden from contributors".

cleanup_mode

boolean

Defaults to false

Enable to delete all keys with all language translations that are not present in the uploaded file. You may want to make a snapshot of the project before importing new file, just in case. By default, no keys are deleted.

custom_translation_status_ids

array of strings

Custom translation status IDs to be added to translations. By default statuses are applied to created and updated translations.

custom_translation_status_ids

custom_translation_status_inserted_keys

boolean

Defaults to true

Add specified custom translation statuses to inserted keys. Has no effect if custom_translation_status_ids is empty.

custom_translation_status_updated_keys

boolean

Defaults to true

Add specified custom translation statuses to updated keys. Has no effect if custom_translation_status_ids is empty.

custom_translation_status_skipped_keys

boolean

Defaults to false

Add specified custom translation statuses to skipped keys. Has no effect if custom_translation_status_ids is empty.

skip_detect_lang_iso

boolean

Defaults to false

Skip automatic language detection by filename.

format

string

File format (e.g. json, strings, xml). Must be file extension of any of the file formats we support. If omitted, the format is detected from the extension of filename.

filter_task_id

number

Apply import results as a part of a task. Available only for offline_xliff file format.

title

string

length ≤ 256

Set a human-readable title for the uploaded file, displayed in the UI instead of the filename. Maximum 256 characters. Relevant for Marketing and support (M&S) project types only.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

202Accepted

302Found