GoRunner docs
Search or askSearch⌘K

Rename or move a folder

PUT/api/folders/{id}

Renames a folder, moves it, or both, in one write.

Needs an API token with the Write permission for workflows (workflow:write).

Warning Send parentId every time. Leaving it out moves the folder to the top level. To rename in place, send its current parentId.

Parameters

Path

idRequired · UUID

The folder’s ID.

Body

nameRequired · string

The name, new or the same. Up to 255 characters, trimmed, and different from the other folders in that place.

parentIdOptional · UUID

Where the folder goes, exactly as sent: null or left out is the top level. Not the folder itself or a folder inside it.

Responses

  • 200OK

    Done. The answer doesn’t hold the folder: list the folders to see it.

  • The ID isn’t a UUID, the body isn’t JSON, or the name is blank or over 255 characters.

  • The new place is the folder itself, a folder inside it, or not a folder in this workspace.

  • The token lacks the Write permission for workflows.

  • No folder with this ID in the workspace.

  • A folder with this name is already in that place. Names are compared without case.

  • Nothing changed. Try again.

Any call can also answer: 401 UNAUTHORIZED · 401 TOKEN_ENDED · 403 TOKEN_SURFACE_OFF · 403 FEATURE_OFF · 403 EMBED_NOT_ALLOWED · 403 EMBED_NOT_AVAILABLE · 403 ACCOUNT_SUSPENDED · 413 PAYLOAD_TOO_LARGE · 415 INVALID_CONTENT_TYPE · 429 RATE_LIMITED · 503 BUSY · 503 PAUSED · 503 SERVICE_UNAVAILABLE. See Errors.

Request

GORUNNER="https://api.gorunner.io"
GORUNNER_TOKEN="grt_…"  # needs Write for workflows
FOLDER_ID="your-folder-id"

curl -X PUT "$GORUNNER/api/folders/$FOLDER_ID" \
  -H "Authorization: Bearer $GORUNNER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Invoices 2026",
    "parentId": "7a2c9e41-5b3d-4f08-a6e1-2d9c4b7f0e13"
  }'

Response · 200 OK

json
{
  "data": {
    "id": "6e9a1c3f-8b2d-4a57-9e0c-3f7b5d1a8c42",
    "updated": true
  }
}
Every field

Body

nameRequired · string

Required; trimmed. Blank, or longer than 255 characters, is a 400. A name another folder in the new place already has, ignoring case, is a 409 NAME_TAKEN.

parentIdOptional · UUID

The new parent, applied EXACTLY as sent. Omitting it (or sending null) MOVES THE FOLDER TO THE ROOT — to rename without moving, re-send the folder’s current parentId. Cannot be the folder itself or one of its descendants.

Response · 200 OK

dataobject

Bare acknowledgement returned by folder update and delete. It does NOT contain the folder — re-list if you need the new state.

idUUID

The folder the operation applied to.

updatedboolean

Always true; present on the update response only.

deletedboolean

Always true; present on the delete response only.