Edit Project

Edit Crowdin project.

Request

POST http://api.crowdin.net/api/project/{project-identifier}/edit-project?key={key}

Parameters

Name Value Description
keyrequired string Project API key.
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_approved_onlyoptional bool If set to 1 only approved translations will be exported in resulted ZIP file. 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.
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.

Response

If successful, this method returns a XML structure, as shown below. 
<?xml version="1.0" encoding="ISO-8859-1"?>

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

Sample unsuccessful response: 
<?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 "hide_duplicates=0" \
-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" \
http://api.crowdin.net/api/project/{project-identifier}/edit-project?key={project-key}

API Methods

Related articles