Edit Project

Edit Crowdin project.

Request

POST https://api.crowdin.com/api/project/{project-identifier}/edit-project?key={project-key}

Parameters

Name Value Description
nameoptional string Project name.
languagesoptional array An array of language codes a project should be translate to.
join_policyoptional string Project join policy. Acceptable values are:
  • open
  • private
language_access_policy optional string Defines how project members can access target languages. Acceptable values are:
  • "open" - any translator can access any language.
  • "moderate" - translator should be granted with access to certain language.
hide_duplicatesoptional bool Defines whether duplicated strings should be displayed to translators or should be hidden and translated automatically. Acceptable values are: 1 or 0.
export_translated_onlyoptional bool Defines whether only translated strings will be exported to the final file. We do not recommend to set this option if you have text (*.html, *.txt, *.docx etc.) documents in your project since it may damage resulted files. Acceptable values are: 1 or 0.
export_approved_onlyoptional bool If set to 1 only approved translations will be exported in resulted ZIP file. Acceptable values are: 1 or 0.
auto_translate_dialectsoptional bool Untranslated strings of dialect will be translated automatically in exported file, leveraging translations from main language. Acceptable values are: 1 or 0.
public_downloadsoptional bool Defines whether "Download" button visible to everyone on Crowdin webpages. Acceptable values are: 1 or 0.
use_global_tmoptional bool Defines if translations would be leveraged from Crowdin Global Translation Memory. When using this option any translations made in your project will be commited to Crowdin Global TM automatically. Acceptable values are: 1 or 0.
logooptional file Project logo at Crowdin.
cnameoptional string Custom domain name for Crowdin project.
descriptionoptional string Project description.
webhook_file_translatedoptional string Open this URL when one of the project files is translated. URL will be opened with "project" - project identifier, "language" - language code and "file" - file name.
webhook_file_proofreadoptional string Open this URL when one of the project files is proofread. URL will be opened with "project" - project identifier, "language" - language code and "file" - file name.
webhook_project_translatedoptional string Open this URL when project translation is complete. URL will be opened with "project" - project identifier and "language" - language code.
webhook_project_proofreadoptional string Open this URL when project proofreading is complete. URL will be opened with "project" - project identifier and "language" - language code.
jsonoptional string May not contain value. Defines that response should be in JSON format.
jsonpoptional string Callback function name. Defines that response should be in JSONP format.
Variables
project-identifierrequired string Should contain the project identifier.
project-keyrequired string Project API key.

Response

If the method is successful, it responds with an XML structure, as it is shown below (when language_access_policy = open).
<?xml version="1.0" encoding="ISO-8859-1"?>

  1
  http://translate.example.com/project/test-project-api/invite
  http://translate.example.com/project/test-project-api


Response example for projects with "Moderate" language_access_policy.
<?xml version="1.0" encoding="ISO-8859-1"?>

  1
  
    
      Ukrainian
      http://translate.example.com/project/test-project-api/invite?d=7585662585d5d32307d3937373
      http://translate.example.com/project/test-project-api/invite?d=3585k635r4d5d32307d3937373
    
  
  https://crowdin.com/project/test-project-api



Unsuccessful response sample:
<?xml version="1.0" encoding="ISO-8859-1"?>

  3
  API key is not valid


Examples

curl \
-F "logo=@logo.png" \
-F "name=new project name" \
-F "description=new project description" \
-F "cname=new.example.com" \
-F "languages[]=de" \
-F "languages[]=fr" \
-F "languages[]=zh-CN" \
-F "hide_duplicates=1" \
-F "export_approved_only=0" \
-F "public_downloads=1" \
https://api.crowdin.com/api/project/{project-identifier}/edit-project?key={project-key}