Update a Team Space folder

PATCH

/v1/workspaces/{workspaceId}/folders/{folderId}

curl --request PATCH \
  --url https://shareout.site/v1/workspaces/example/folders/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "slug": "example", "description": "example", "readme": "example", "visibility": "inherit" }'

• Production

Also accepts PUT. Owners/admins for any folder; a member only for folders they created, while members_can_create_folders is on (otherwise 403 ADMIN_REQUIRED).

Authorizations

• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

folderId

required

string

Request Body^required

Media typeapplication/json

object

name

string

slug

string

description

string | null

readme

string

visibility

string

Allowed values: inherit public workspace private

Responses

200

Updated folder

Media typeapplication/json

object

id

string

name

string

slug

string

description

string | null

artifact_count

integer

parent_id

Team Space folders only.

string | null

visibility

Team Space folders only.

string

Allowed values: inherit public workspace private

subfolder_count

Team Space folders only.

integer

path

Slug path; single-folder Team Space responses only.

string

readme

Single-folder Team Space responses only.

string | null

effective_visibility

Single-folder Team Space responses only.

string

created_at

string format: date-time

Example

{
  "visibility": "inherit"
}

400

Invalid request

Media typeapplication/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}

404

Resource not found

Media typeapplication/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}

409

Slug taken or version conflict

Media typeapplication/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}