Edit Project

Edit Crowdin project.

Request

POST http://api.crowdin.net/api/project/{project-identifier}/edit-project?key={account-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 moderate private
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.
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={account-key}

<?php
  $post_params = array();
  $request_url = 'http://api.crowdin.net/api/project/{project-identifier}/edit-project?key={account-key}';
  $post_params['name'] = 'new project name';
  $post_params['join_policy'] = 'open';
  $post_params['languages[]'] = 'fr';
  $post_params['languages[]'] = 'de';
  $post_params['languages[]'] = 'zh-CN';

  $ch = curl_init();
  curl_setopt($ch, CURLOPT_URL, $request_url);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_POST, true);
  curl_setopt($ch, CURLOPT_POSTFIELDS, $post_params);

  $result = curl_exec($ch);
  curl_close($ch);

  echo $result;

Edit Project

Request

Parameters

Response

Examples

API Methods

Related articles