Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Releases

Create a release

Create a new release.

post/accounts/{account_id}/distributions/{distribution_id}/releases

Path parameters

account_idstring required

Account ID

distribution_idstring required

Distribution ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

descriptionstring

Description of the release

platformsstring[]

List of platforms the release should support.

locale_idsstring[]

List of locale ids that will be included in the release. If empty, distribution locales will be used

tagsstring[]

Only include tagged keys in the release. For a key to be included it must be tagged with all tags provided

app_min_versionstring

Minimum version of the app that the release supports in semver format

app_max_versionstring

Maximum version of the app that the release supports in semver format

branchstring

Branch used for release

Example request

{
  "description": "My first Release",
  "platforms": [
    "android",
    "ios"
  ],
  "locale_ids": [
    "abcd1234cdef1234abcd1234cdef1234",
    "fff565db236400772368235db2c6117e"
  ],
  "tags": [
    "android",
    "feature1"
  ],
  "app_min_version": "2.5.0",
  "app_max_version": "3.0.0",
  "branch": "my-feature-branch"
}

Response

Created

idstring
versioninteger
app_min_versionstring
app_max_versionstring
descriptionstring
platformsstring[]
environmentsstring[]
tagsstring[]
statestring
created_atstring date-time
updated_atstring date-time

Example response

{
  "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",
    "production"
  ],
  "locales": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "name": "English",
      "code": "en-GB"
    }
  ],
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}