Skip to content

Set activity visibility for one kind

PUT
/v1/home/event-visibility
curl --request PUT \
--url 'https://shareout.site/v1/home/event-visibility?workspace=example' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "kind": "example", "audience": "self" }'
workspace
required
string
Media typeapplication/json
object
kind
required

Activity kind (e.g. view, comment, run).

string
audience
required
string
Allowed values: self members admins off

Updated

Media typeapplication/json
object
ok
boolean
Examplegenerated
{
"ok": true
}

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