Documents API: Copy folder

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/documents/copy_folder
Handler	OperatelyWeb.Api.ResourceHubs.CopyFolder

Authentication#

• Requires a valid API token.
• Requires a write-enabled token.
• Read-only tokens return 403.

Inputs#

Field	Type	Required	Nullable	Default
folder_name	string	No	No	-
folder_id	id primitive (encoded as string)	Yes	No	-
dest_parent_folder_id	id primitive (encoded as string)	No	Yes	-

Outputs#

Field	Type	Required	Nullable
folder_id	id primitive (encoded as string)	Yes	No

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/documents/copy_folder" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"dest_parent_folder_id":"value", "folder_id":"value", "folder_name":"value"}'

Response Example#

{
  "folder_id": "value"
}