Skip to content

Let members send support diagnostics, or block them

PUT
/orgs/{org}/support-diagnostics
curl --request PUT \
--url https://api.sloose.com/orgs/org_9f3c/support-diagnostics \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "supportDiagnostics": "default" }'

Sets the org’s support diagnostics. blocked turns them off for everybody in the org at once: every member’s page stops collecting them as it next reads who it is for. default gives each member their own choice back, on unless they opted out.

An administrator, in a signed-in session: an API token may read the setting and not change it. A staff member’s view may block diagnostics and may not unblock them (IMPERSONATION_REFUSED). Recorded in the org’s change log; it moves no configuration version.

org
required

The org id the session was issued for. A token for one org can never read another.

string
Example
org_9f3c

The org id the session was issued for. A token for one org can never read another.

Media typeapplication/json
object
supportDiagnostics
required

default: each member’s own choice, on unless they opt out. blocked: off for everybody in the org, and not offered.

string
Allowed values: default blocked

The org’s setting now.

Media typeapplication/json
object
supportDiagnostics
required

default: each member’s own choice, on unless they opt out. blocked: off for everybody in the org, and not offered.

string
Allowed values: default blocked
changed
required

False when the org already had that setting: nothing was written.

boolean
Example
{
"supportDiagnostics": "default"
}

The request — its body or its query — did not match the schema. issues carries the Zod issue list.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object
error
required

Human-readable explanation.

string
code

Machine-readable reason. Absent on a few legacy 400s.

string
key
additional properties
Examplegenerated
{
"error": "example",
"code": "example"
}

No bearer, or one that is expired, revoked or no longer resolves to a member.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object
error
required

Human-readable explanation.

string
code

Machine-readable reason. Absent on a few legacy 400s.

string
key
additional properties
Examplegenerated
{
"error": "example",
"code": "example"
}

The bearer’s role is too low, or it was issued for a different org.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object
error
required

Human-readable explanation.

string
code

Machine-readable reason. Absent on a few legacy 400s.

string
key
additional properties
Examplegenerated
{
"error": "example",
"code": "example"
}

No such org, or it is not visible to this session.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object
error
required

Human-readable explanation.

string
code

Machine-readable reason. Absent on a few legacy 400s.

string
key
additional properties
Examplegenerated
{
"error": "example",
"code": "example"
}

Report a problem with this page