Skip to content

rename

Endpoint#

PropertyValue
Typemutation
MethodPOST
Path/api/external/v1/folders/rename
HandlerOperatelyWeb.Api.Folders.Rename

Authentication#

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

Inputs#

FieldTypeRequiredNullableDefault
folder_idid primitive (encoded as string)YesNo-
new_namestringYesNo-

Outputs#

FieldTypeRequiredNullable
successbooleanYesNo

cURL Example#

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

Response Example#

{
  "success": true
}