PUT/v1/comms/settings/visibility

Set who may see messages by default

Replaces the whole bag of visibility defaults, keyed by medium and by inbox. A key the body leaves out is DROPPED, which is exactly how a privacy pane turns one back off, so send the full bag. A key naming an inbox the workspace does not have is refused, quoting it. Admin only.

Access class: workspace:admin.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Request body

application/jsonrequired

bodyoptional

paramsobjectoptional

queryobjectoptional

Responses

200application/json

the action's answer

{
  "defaults": {
    "call": "string",
    "email": "string",
    "imessage": "string",
    "sms": "string"
  }
}

defaultsrequired

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired