Skip to main content
PATCH
/
projects
/
{id}
cURL
curl "https://api.phrase.com/v2/projects/:id" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X PATCH \
  -F name=My%20Android%20Project \
  -F main_format=yml \
  -F shares_translation_memory=true
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "name": "My Android Project",
  "slug": "my-android-project",
  "main_format": "xml",
  "project_image_url": "http://assets.example.com/project.png",
  "account": "account",
  "space": "space",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "shares_translation_memory": true
}

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

​
id
string
required

ID

Body

application/json
​
account_id
string

Required if the requesting user is a member of multiple accounts. Account ID to specify the actual account the project should be created in.

Example:

"abcd1234"

​
name
string

(Optional) Name of the project

Example:

"My Android Project"

​
point_of_contact
string

(Optional) User ID of the point of contact for the project. Pass null to unset.

Example:

"abcd1234"

​
main_format
string

(Optional) Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see Format Guide or our Formats API Endpoint.

Example:

"yml"

​
media
string

(Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include: Ruby, JavaScript, AngularJS, React, iOS, Android, Python, PHP, Java, Go, Windows Phone, Rails, Node.js, .NET, Django, Symfony, Yii Framework, Zend Framework, Apple App Store Description, Google Play Description, but it can also take any other value.

Example:

"Python"

​
shares_translation_memory
boolean

(Optional) Indicates whether the project should share the account's translation memory

Example:

true

​
project_image
file

(Optional) Image to identify the project

Example:

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

​
remove_project_image
boolean

(Optional) Indicates whether the project image should be deleted.

Example:

false

​
workflow
string

(Optional) Review Workflow. "simple" / "review". Read more

Example:

"review"

​
machine_translation_enabled
boolean

(Optional) Enable machine translation support in the project. Required for Pre-Translation

Example:

true

​
enable_branching
boolean

(Optional) Enable branching in the project

Example:

true

​
protect_master_branch
boolean

(Optional) Protect the master branch in project where branching is enabled

Example:

true

​
enable_all_data_type_translation_keys_for_translators
boolean

(Optional) Otherwise, translators are not allowed to edit translations other than strings

Example:

true

​
enable_icu_message_format
boolean

(Optional) We can validate and highlight your ICU messages. Read more

Example:

true

​
zero_plural_form_enabled
boolean

(Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly.

Example:

true

​
autotranslate_enabled
boolean

(Optional) Autopilot, requires machine_translation_enabled. Read more

Example:

true

​
autotranslate_check_new_translation_keys
boolean

(Optional) Requires autotranslate_enabled to be true

Example:

true

​
autotranslate_check_new_uploads
boolean

(Optional) Requires autotranslate_enabled to be true

Example:

true

​
autotranslate_check_new_locales
boolean

(Optional) Requires autotranslate_enabled to be true

Example:

true

​
autotranslate_mark_as_unverified
boolean

(Optional) Requires autotranslate_enabled to be true

Example:

true

​
autotranslate_use_machine_translation
boolean

(Optional) Requires autotranslate_enabled to be true

Example:

true

​
autotranslate_use_translation_memory
boolean

(Optional) Requires autotranslate_enabled to be true

Example:

true

​
default_encoding
enum<string>

(Optional) Sets the default encoding for Uploads. If you leave it empty, we will try to guess it automatically for you when you Upload a file. You can still override this value by setting the file_encoding parameter for Uploads.

Available options:
UTF-8,
UTF-16,
UTF-16BE,
UTF-16LE,
ISO-8859-1
Example:

"UTF-8"

Response

OK

​
id
string
​
name
string
​
slug
string
​
main_format
string
​
project_image_url
string
​
media
string
​
account
account · object
Example:
{
  "id": "abcd1234",
  "name": "Company Account",
  "slug": "company_account",
  "company": "My Awesome Company",
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z",
  "company_logo_url": "http://assets.example.com/company_logo.png"
}
​
space
space · object
Example:
{
  "id": "2e7574e8f2372906a03110c2a7cfe671",
  "name": "My first space",
  "created_at": "2020-02-25T12:17:25Z",
  "updated_at": "2020-03-13T14:46:57Z",
  "projects_count": 2
}
​
point_of_contact
user_preview · object
Example:

null

​
created_at
string<date-time>
​
updated_at
string<date-time>
​
shares_translation_memory
boolean