Skip to main content
PATCH
/
accounts
/
{account_id}
/
distributions
/
{id}
cURL
curl "https://api.phrase.com/v2/accounts/:account_id/distributions/:id" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X PATCH \
  -d '{"name":"My Android Distribution","project_id":"abcd1234abcd1234abcd1234","platforms":["android","ios"],"locale_ids":["fff565db236400772368235db2c6117e,abcd1234cdef1234abcd1234cdef1234"],"format_options":"{xml:{enclose_in_cdata:'1'}}","fallback_to_non_regional_locale":true,"fallback_to_default_locale":true,"use_last_reviewed_version":true}' \
  -H 'Content-Type: application/json'
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "Android Distribution",
  "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"
  ],
  "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"
    }
  ],
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}

Authorizations

​
Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

​
X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

​
account_id
string
required

Account ID

​
id
string
required

ID

Body

application/json
​
name
string

Name of the distribution

Example:

"My Android Distribution"

​
project_id
string

Project id the distribution should be assigned to.

Example:

"abcd1234abcd1234abcd1234"

​
platforms
string[]

List of platforms the distribution should support.

Example:
["android", "ios"]
​
locale_ids
string[]

List of locale ids that will be part of distribution releases

Example:
[
  "abcd1234cdef1234abcd1234cdef1234",
  "fff565db236400772368235db2c6117e"
]
​
format_options
object

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

Example:

"{xml:{enclose_in_cdata:'1'}}"

​
fallback_locales_enabled
boolean

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

Example:

true

​
fallback_to_non_regional_locale
boolean

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

Example:

true

​
fallback_to_default_locale
boolean

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

Example:

true

​
use_last_reviewed_version
boolean

Use last reviewed instead of latest translation in a project

Example:

true

Response

OK

​
id
string
​
name
string
​
project
project_short · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "My Android Project",
  "main_format": "xml",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}
​
platforms
string[]
​
locales
locale_preview · object[]
​
releases
release_preview · object[]
​
created_at
string<date-time>
​
deleted_at
string<date-time>