Add Directory

Add directory to Crowdin project.

Request

Note: Either use the combination of project identifier and project key or combination of project identifier, username, and account key to pass to this endpoint.

POST https://api.crowdin.com/api/project/{project-identifier}/add-directory?key={project-key}&name={directory name}
POST https://api.crowdin.com/api/project/{project-identifier}/add-directory?login={username}&account-key={account-key}&name={directory name}

Parameters

Name Value Description
name required string Directory name (with path if nested directory should be created).
title optional string Directory title to be displayed in Crowdin UI.
export_pattern optional string Directory export pattern. Is used to create directory name and path in resulted translations bundle.
recursive optional bool If set to 1 each directory will be created from a nested name. Acceptable values are: 1 or 0. Default is 0.
is_branch optional bool If set to 1 the directory will be marked as a version branch. Acceptable values are: 1 or 0. Default is 0.
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 string Project identifier.
project-key string Project API key. Either the project-key or combination of username and account-key are required.
username string Your username in Crowdin. Either the project-key or combination of username and account-key are required.
account-key string Your account API key. Either the project-key or combination of username and account-key are required.

Response

If the method is successful, it responds with an 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" \
  https://api.crowdin.com/api/project/{project-identifier}/add-directory?key={project-key}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/add-directory?key={project-key}';
$post_params['name'] = '/localizable';

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

Was this article helpful?