Create a key

cURL

curl "https://api.phrase.com/v2/projects/:project_id/keys" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -F branch=my-feature-branch \
  -F name=home.index.headline \
  -F description=Some%20description%20worth%20knowing... \
  -F name_plural=home.index.headlines \
  -F data_type=number \
  -F tags=awesome-feature,needs-proofreading \
  -F max_characters_allowed=140 \
  -F screenshot=@/path/to/my/screenshot.png
  -F custom_metadata[property]=value

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "home.index.headline",
  "description": "My description for this key...",
  "name_hash": "1b31d2580ce324f246f66b3be00ed399",
  "plural": false,
  "use_ordinal_rules": false,
  "tags": [
    "awesome-feature",
    "needs-proofreading"
  ],
  "data_type": "string",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "name_plural": "home.index.headlines",
  "comments_count": 2,
  "max_characters_allowed": 140,
  "screenshot_url": "http://assets.example.com/screenshot.png",
  "unformatted": false,
  "xml_space_preserve": false,
  "original_file": "",
  "format_value_type": "",
  "creator": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "joe.doe",
    "name": "Joe Doe"
  },
  "custom_metadata": {
    "fruit": "Apple",
    "vegetable": "Tomato"
  }
}

POST

projects

{project_id}

keys

cURL

curl "https://api.phrase.com/v2/projects/:project_id/keys" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -F branch=my-feature-branch \
  -F name=home.index.headline \
  -F description=Some%20description%20worth%20knowing... \
  -F name_plural=home.index.headlines \
  -F data_type=number \
  -F tags=awesome-feature,needs-proofreading \
  -F max_characters_allowed=140 \
  -F screenshot=@/path/to/my/screenshot.png
  -F custom_metadata[property]=value

{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "home.index.headline",
  "description": "My description for this key...",
  "name_hash": "1b31d2580ce324f246f66b3be00ed399",
  "plural": false,
  "use_ordinal_rules": false,
  "tags": [
    "awesome-feature",
    "needs-proofreading"
  ],
  "data_type": "string",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "name_plural": "home.index.headlines",
  "comments_count": 2,
  "max_characters_allowed": 140,
  "screenshot_url": "http://assets.example.com/screenshot.png",
  "unformatted": false,
  "xml_space_preserve": false,
  "original_file": "",
  "format_value_type": "",
  "creator": {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "username": "joe.doe",
    "name": "Joe Doe"
  },
  "custom_metadata": {
    "fruit": "Apple",
    "vegetable": "Tomato"
  }
}

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

project_id

string

required

Project ID

Body

application/json

name

string

required

Key name

Example:

"home.index.headline"

branch

string

specify the branch to use

Example:

"my-feature-branch"

description

string

Key description (usually includes contextual information for translators)

Example:

"Some description worth knowing..."

plural

boolean

Indicates whether key supports pluralization

Example:

null

use_ordinal_rules

boolean

Indicates whether key uses ordinal rules for pluralization

Example:

null

name_plural

string

Plural name for the key (used in some file formats, e.g. Gettext)

Example:

"home.index.headlines"

data_type

string

Type of the key. Can be one of the following: string, number, boolean, array, markdown.

Example:

"number"

tags

string

List of tags separated by comma to be associated with the key.

Example:

"awesome-feature,needs-proofreading"

max_characters_allowed

integer

Max. number of characters translations for this key can have.

Example:

140

screenshot

file

deprecated

Screenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead.

Example:

"/path/to/my/screenshot.png"

remove_screenshot

boolean

deprecated

Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead.

Example:

null

unformatted

boolean

Indicates whether the key should be exported as "unformatted". Supported by Android XML and other formats.

Example:

null

default_translation_content

string

Creates a translation in the default locale with the specified content

Example:

"Default translation content"

autotranslate

boolean

Indicates whether the key should be autotranslated to other locales based on the copy provided in default_translation_content.

Example:

null

xml_space_preserve

boolean

Indicates whether the key should be exported with "xml:space=preserve". Supported by several XML-based formats.

Example:

null

original_file

string

Original file attribute. Used in some formats, e.g. XLIFF.

Example:

null

localized_format_string

string

NSStringLocalizedFormatKey attribute. Used in .stringsdict format.

Example:

null

localized_format_key

string

NSStringLocalizedFormatKey attribute. Used in .stringsdict format.

Example:

null

custom_metadata

object

Custom metadata property name and value pairs to be associated with key.

Example:

{ "fruit": "Apple", "vegetable": "Tomato" }

Response

Created

string

name

string

description

string

name_hash

string

plural

boolean

use_ordinal_rules

boolean

Guides

API Documentation

Authorizations

Headers

Path Parameters

Body

Response