v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB

Locales

Create a locale

Create a new locale.

post/projects/{project_id}/locales

Path parameters

project_idstring required

Project ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

branchstring

specify the branch to use

namestring required

Locale name

codestring required

Locale ISO code

defaultboolean

Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale.

mainboolean

Indicates whether locale is a main locale. Main locales are part of the Verification System feature.

rtlboolean

Indicates whether locale is a RTL (Right-to-Left) locale.

source_locale_idstring

Source locale. Can be the name or id of the locale. Preferred is id.

fallback_locale_idstring

Fallback locale for empty translations. Can be a locale name or id.

unverify_new_translationsboolean

Indicates that new translations for this locale should be marked as unverified. Part of the Advanced Workflows feature.

unverify_updated_translationsboolean

Indicates that updated translations for this locale should be marked as unverified. Part of the Advanced Workflows feature.

autotranslateboolean

If set, translations for this locale will be fetched automatically, right after creation.

language_ai_profilestring

Identifier of the Language AI profile to use for this locale.

Example request

{
  "branch": "my-feature-branch",
  "name": "de",
  "code": "de-DE",
  "source_locale_id": "abcd1234abcd1234abcd1234abcd1234",
  "fallback_locale_id": "abcd1234abcd1234abcd1234abcd1234",
  "language_ai_profile": "abcd1234abcd1234abcd1234abcd1234"
}

Response

Created

idstring

namestring

codestring

defaultboolean

mainboolean

rtlboolean

plural_formsstring[]

ordinal_plural_formsstring[]

language_ai_profilestring

created_atstring date-time

updated_atstring date-time

Example response

{
  "statistics": {
    "keys_total_count": 2120,
    "keys_untranslated_count": 100,
    "words_total_count": 3102102,
    "translations_completed_count": 1920,
    "translations_unverified_count": 32,
    "unverified_words_count": 129,
    "missing_words_count": 3920
  }
}