Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Distributions

Create a distribution

Create a new distribution.

post/accounts/{account_id}/distributions

Path parameters

account_idstring required

Account ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

namestring required

Name of the distribution

project_idstring required

Project id the distribution should be assigned to.

platformsstring[]

List of platforms the distribution should support. Valid values are:

  • android
  • ios
  • flutter
  • i18next
  • rails
locale_idsstring[]

List of locale ids that will be part of distribution releases

format_optionsobject

Additional formatting and render options. Only enclose_in_cdata is available for platform android.

fallback_locales_enabledboolean

Use fallback locale if there is no translation in the current locale.

fallback_to_non_regional_localeboolean

Indicates whether to fallback to non regional locale when locale can not be found

fallback_to_default_localeboolean

Indicates whether to fallback to projects default locale when locale can not be found

use_last_reviewed_versionboolean

Use last reviewed instead of latest translation in a project

Example request

{
  "name": "My Android Distribution",
  "project_id": "abcd1234abcd1234abcd1234",
  "platforms": [
    "android",
    "ios"
  ],
  "locale_ids": [
    "abcd1234cdef1234abcd1234cdef1234",
    "fff565db236400772368235db2c6117e"
  ],
  "fallback_locales_enabled": true,
  "fallback_to_non_regional_locale": true,
  "fallback_to_default_locale": true,
  "use_last_reviewed_version": true
}

Response

Created

idstring
namestring
platformsstring[]
release_countinteger
created_atstring date-time
updated_atstring date-time
deleted_atstring date-time nullable

Example response

{
  "locales": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "English",
      "code": "en-GB"
    }
  ],
  "releases": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "version": 1,
      "project": {
        "id": "abcd1234cdef1234abcd1234cdef1234",
        "name": "My Android Project",
        "main_format": "xml",
        "created_at": "2015-01-28T09:52:53Z",
        "updated_at": "2015-01-28T09:52:53Z"
      },
      "platforms": [
        "android"
      ],
      "environments": [
        "development"
      ],
      "locale_codes": [
        "de",
        "en"
      ],
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-01-28T09:52:53Z"
    }
  ]
}