< Return to Method List

Method: folders.move

Description

Moves a folder. Can be moved into another folder, or placed in the root.

Arguments

Name	Mandatory	Description
session_key	Yes	Received from auth.login
folder_id	Yes	A folder_id code or list of folders' id's (a1a1a1,s2s2s2,d3d3d3)
parent_folder_id	Yes	folder_id code or 0 for root folder

Returns

Minimal folder information(s) and comma-separated list of IDs suceeded to move in an "id" tag. One or several error messages, optionally containing specific reason and IDs of those folders failed in an "id" property.

Response

<!-- successful response -->
<result method="folders.move" status="ok">
    <id>abcdef,abcdeg</id>
    <folder id="abcdef" />
    <folder id="abcdeg" />
</result>       
									
<!-- failed response -->
<result method="folders.move" status="fail">
    <error code="..." text="Permission denied"/>
</result>
									
<!-- mixed response -->
<result method="folders.move" status="ok">
    <id>abcdef,abcdeg<id>
    <folder id="abcdef" />
    <folder id="abcdeg" />
    <error code="..." text="..." id="abcdeh,abcdek" />
    <error code="..." text="..." id="abcdei,abcdej" />
</result>

Possible Errors

Code	Name	Description
6	API_ERROR_SESSION_BAD	Session expired or not found
10	API_ERROR_FOLDER_NOT_FOUND	Folder not found
11	API_ERROR_PERMISSION_DENIED	Permission denied
31	API_ERROR_BAD_TARGET_FOLDER	Invalid target folder selected