/documents/v1/move/{item_id}

post

https://api.safetyculture.io/documents/v1/move/{item_id}

Use this endpoint to move a file or folder to a different location in Documents, where it will automatically inherit the access rules of the destination folder.

📘
If no target_folder_id is provided, the file or folder will be moved to the root folder.

Requirements

Limitations

Each folder can contain up to 200 items, which includes both files and subfolders.
Each file or subfolder can only be in one folder at a time. If you move a file or subfolder to a new folder, it will be removed from its current one.

Path Params

item_id

string

required

The ID of the item (file or folder) you want to move.
To get the item_id, open the item in the SafetyCulture web app and copy the last part of the URL.
For example, in this link https://app.safetyculture.com/documents/document/765aa2e6-69cb-43b5-8ab4-48ab26e2a094,
the item ID is 765aa2e6-69cb-43b5-8ab4-48ab26e2a094.

Body Params

Request to move an item (file or folder) to a different folder.

target_folder_id

string

The ID of the folder where the item (file or folder) should be moved.
If you don’t provide a target_folder_id, the item will be moved to the root folder.
To get the target_folder_id, open the target folder in the SafetyCulture web app and copy the last part of the URL.
For example, in this link https://app.safetyculture.com/documents/9dd76834-65ef-41d3-815c-964df32450e4,
the target folder ID is 9dd76834-65ef-41d3-815c-964df32450e4.

Responses

Requirements

Limitations

200A successful response.

defaultAn unexpected error response.