Skip to content
ShareOutShareOut Docs

Turn folder guest comments on or off

PUT
/v1/workspaces/{workspaceId}/folders/{folderId}/guest-comments
curl --request PUT \
  --url https://shareout.site/v1/workspaces/example/folders/example/guest-comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true }'

Admins, or the folder’s creator while members manage their folders. Applies to every artifact in the folder and its subfolders that has no setting of its own; guests still comment only where they can open the page without an account.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspaceId
required
string

Workspace ID or slug.

folderId
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
enabled
required
boolean
Examplegenerated
{
  "enabled": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Saved

Media typeapplication/json
object
folder_id
string
guest_comments
boolean
Examplegenerated
{
  "folder_id": "example",
  "guest_comments": true
}

400

Section titled “400”

VALIDATION_ERROR

403

Section titled “403”

Access denied

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"
    ]
  }
}