Change Directory

Rename directory or modify its attributes. When renaming directory the path can not be changed (it means new_name parameter can not contain path, name only).

Request

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

Parameters

Name Value Description
name required string Full directory path that should be modified (e.g. /MainPage/AboutUs).
new_name optional string New directory name.
title optional string New directory title to be displayed in Crowdin UI.
export_pattern optional string New directory export pattern. Is used to create directory name and path in resulted translations bundle.
branch optional string The name of related version branch (Versions Management).
json optional string May not contain value. Defines that response should be in JSON format.
jsonp optional string Callback function name. Defines that response should be in JSONP format.
Variables
project-identifier required string Should contain the project identifier.
project-key required string Project API key.

Response

If successful, this method returns a XML structure, as it is shown below.
<?xml version="1.0" encoding="ISO-8859-1"?>
<success>
</success>
Unsuccessful response sample:
<?xml version="1.0" encoding="ISO-8859-1"?>
<error>
  <code>3</code>
  <message>API key is not valid</message>
</error>

Examples

curl \
  -F "name=localizable" \
  -F "title=Website" \
  -F "new_name=translatable" \
  https://api.crowdin.com/api/project/{project-identifier}/change-directory?key={project-key}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/change-directory?key={project-key}';
$post_params['name'] = '/localizable/texts';
$post_params['new_name'] = 'translations';

$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;